API

Our APIs are matched to your business use cases. Truuth offers both end-to-end APIs such as identity verification and APIs for more simple use cases including individual steps within our identity verification process. This provides enterprises full flexibility to build a full end-to-end solution on a single API or to bring in certain truuth capabilities into their own custom solutions.

API List

Create Verification Invite API

Initiates the verification journey. Calling this API will create a verification record and generate the invite URL and QR code which can be used to send to the customer to start the verification process.

Visit this link to try out this API or go to our API references page.

Send Verification Invite API

Another method to initiate the verification journey. This API sends an invitation email containing a URL to a customer to start their identity verification process.

Visit this link to try out this API or go to ou

Get Verification Report API

This API will return the pre-signed URL. Please use the pre-signed URL to Download the Verification Report PDF in base64 format. Please note that the Verification Report URL is already provided as part of the callback result.

Visit this link to try out this API or go to our API references page.

Get Business Report API

If the verification has enabled "Company Enquiry Report", calling this API will return the pre-signed URL, use the pre-signed URL to Download the Company Enquiry Report in base64 format. Please note that the Company Enquiry Report URL is already provided as part of the callback result.

Visit this link to try out this API or go to our API references page.

Get Pep and Sanctions Report API

If the verification has enabled "Pep and Sanctions Report", calling this API will return the pre-signed URL, use the pre-signed URL to Download the Pep and Sanctions Report in base64 format. Please note that the Pep and Sanctions Report URL is already provided as part of the callback result.

Visit this link to try out this API or go to our API references page.

Get Face Image API

Download the face image in base64 format. Please note that the face image URL is already provided as part of the callback result, please refer callback section below [results.faceImage][results.faceImage]

Visit this link to try out this API or go to our API references page.

Get Document Image API

Download the document image in base64 format. Please note that the document image URL is already provided as part of the callback result, please refer Callback Section [_results.proofingOutcomes.documents.images][_results.proofingOutcomes.documents.images].

Visit this link to try out this API or go to our API references page.

Callback

When the identity verification is complete an HTTP POST request is sent to your specified callback URL containing an application/JSON formatted string with the verification result in the body.

To use the feature, please setup the webhook as explained in the below link,

Successful integration will receive the below details,

Parameters

The following parameters are posted to your callback URL for Identity verification.

Property	Type	Description
`verificationId`	String	unique verification identifier
`externalRefId`	String	Reference identifier for easy identification
`status`	String	Enum: `DONE` - Verification is completed `IN_PROGRESS` - User is still submitting the document `PROCESSING` - Waiting for verification outcome
`identityOwner`	Object	Please refer to the`Identity Owner` section below for more details
`results.`*proofingOutcomes	Array	Please refer to the`Proofing Outcome` section below for more details
`results.otherCheckOutcomes`	Array	Please refer to `Other Check Outcome`section below for more details
`results.faceImage`	String	Face images URL to retrieve the face image
`results.reports`	Array	Additional reports like 1. Pep and sanctions 2. Company enquiry report will be returned depending on client subscriptions Please refer to the Reports section below for more details
`createdAt`	String	The verification created date-time in YYYY-MM-DDThh:mm:ss:msZ format ie. 1998-12-23T11:47:15.140Z

Identity Owner

Property	Type	Description
`givenName`	string	Given name of the customer from identity documents
`familyName`	string	Family name of the customer from identity documents
`middleName`	string	Middle name of the customer from identity documents
`dateOfBirth`	string	"Date of birth" of the customer from identity documents
email	string	Email of the invited user
gender	string	Possible values are "M", "F"
mobileNumber	string	Mobile number of the invited user

Proofing Outcome

Property	Type	Description
`status`	String	Possible states: `PASS` `FAIL`
`proofingType`	Object	Reffer Proofing Type table below
documents	Array	Returns one array for each document scanned. Please refer to the`Result Document Details` section below for more details
`userBehaviourChecks`	Array	Returns an array of different behavioural checks. Please refer `User Behaviour Checks` section

Proofing Type

Property	Type	Description
`code`	String	IDENTITY_PROOFING `<br/>`ADDRESS_PROOFING`
`name`	String	display name

Other Check Outcome

Property	Type	Description
`type`	String	Available checks are `repeatUserFraudCheck`
`name`	String	`Repeat User Fraud Check`
`status`	String	`PASS` `WARNING` `FAIL`

Other Check Outcome Sub check

Property

Type

Description

type

String

FACE_MISMATCH
SAME_FACE_DIFF_PII
DIFF_FACE_SAME_PII
DIFF_FACE_DIFF_PII_SAME_DOC
SAME_FACE_DIFF_EMAIL
DIFF_FACE_SAME_EMAIL

name

String

Display name of each sub-checks,

FACE_MISMATCH - Different Face (ID Doc & Selfie)
SAME_FACE_DIFF_PII- Same face , different PII
DIFF_FACE_SAME_PII- Different face, same PII
DIFF_FACE_DIFF_PII_SAME_DOC- Different face, same ID
SAME_FACE_DIFF_EMAIL - Same face , different email
DIFF_FACE_SAME_EMAIL- Different face, same email

status

String

PASS FAIL

If all outcome subchecks have a status of PASS then overall repeatUserFraudCheck outcome will have a status of PASS.
If subchecks SAME_FACE_DIFF_EMAIL or/and DIFF_FACE_SAME_EMAIL have a status of FAIL and other subchecks have a status of PASS then overall check outcome will be WARNING.
If any of the other subchecks have a status of FAIL then overall check outcome will be FAIL.

User Behaviour Checks

This object contains details of different user behaviour checks

Property	Type	Description
`type`	String	security check type `liveness` `docSubmissionCheck t&c`
`name`	String	`Liveness` `Doc Submission Check` `T&C`
`status`	String	`PASS` `FAIL`
`score`	number	Liveness score range between 0 to 1 Note: score is applicable only for Liveness

Reports

If the result is FAIL then we need to supply the following failure reasons (NB: it is possible to have more than one reason):

Property

Type

Description

type

String

SANCTIONS_AND_PEP_REPORT
AUS_BUSINESS_VERIFICATION_REPORT
FRAUD_CHECK_REPORT
IDV_VERIFICATION_REPORT_V2

reportUrl

String

can be used to download the verification outcome in below format.
SANCTIONS_AND_PEP_REPORT - PDF Format
AUS_BUSINESS_VERIFICATION_REPORT - PDF Format
FRAUD_CHECK_REPORT - CSV Format
IDV_VERIFICATION_REPORT_V2 - PDF Format

Authentication Type: BASIC

details.status

String

IN_PROGRESS DONE ERROR

Result Document Details

This object contains details for an individual document.

Property	Type	Description
`documentType`	String	`PASSPORT` `DRIVERS LICENCE` `MEDICARE`
`documentDisplayName`	String	User-friendly name is given in the proofing framework
`documentClassificationCode`	String	Used to identify the classification of the code. Format: DocumentType.CountryCode.Class.SubClass Class and Sub Class will be used to get more detail abt the document
`category`	String	Document category can be `PRIMARY` Or `LINKING` `PRIMARY` - Document used as the main document to prove identity `LINKING` - If there is a name mismatch between 2 documents then linking documents will be used to prove both names are the same
`documentData`	Object	Identity document extract details. Please refer to the Identity Document Data section below for more information
`countryCode`	String	"AUS"
`securityChecks`	Array	Document security check status. Please refer `Security check details` section below for more details
`images`	Array	Document images Url. Please refer `Identity Document Image Details` section below for more details
`status`	String	Possible states: `PASS` If all security check is marked as PASS `FAIL` If one of the security check is Fail `WARNING`: If one of the security check is marked as Warning and others are Pass

Identity Document Data - Object definition

Property	Type	Description
`key`	String	document field name
`value`	String	Value of the document data field.
`confidence`	Number	The data field extracts the confidence score. min: 0, max: 1

Security Check Details

This object contains details of different user behaviour checks

Property	Type	Description
`type`	String	Reffer Available Security checks in the below table
`name`	String	Friendly name
`status`	String	`PASS` `FAIL` `WARNING` `NOT_PERFORMED`
`score`	number	Score is applicable only for `documentAuthenticity.` min: 0, max: 1
`subChecks`	Array	Sub checks are applicable only for `documentAuthenticity`

Available Security checks

Property	Description
`expiryCheck`	Check if the document provided is expired or not
`faceMatch`	Ensures the selfie and provided identity document face matches or not
`nameMatch`	Ensures the name of all documents provided is matching or not
`dobMatch`	Ensures the dob of all documents provided is matching or not `NA` will be returned for a document which doesn't have `dateOfBirth`.
`sourceCheck`	Verifies the document with the provider of the document. In Australia, DVS does document verification. This check will happen only if this feature is enabled for your subscription.
`irnMatch`	Verifies the provided individual reference number matches one of the names on the medicare card. This is applicable only for australian medicare
`documentAuthenticity`	Verifies the authenticity of the document
`documentOcr`	Verifies the document extract information
`dataEditCheck`	This check gives the visibility of whether the user edited the data or not when the review edit feature is turned On
`documentRecencyCheck`	To ensure whether the document provided is recent or not
`allowedDocumentCheck`	To ensure the supplied document is allowed or not

Authenticity Sub-Check Details

Property	Type	Description
`type`	String	`TEXT_FEATURES` `BLACK_WHITE` `EXPIRY`
`name`	String	Friendly name
`score`	number	The score is applicable only to the`documentAuthenticity sub-check.` min: 0, max: 1

Available Authenticity Sub-Check

Property	Description
`TEXT_FEATURES`	Text feature classification can be used to eliminate fake documents by identifying patterns or features in the document that are inconsistent with authentic documents.
`BLACK_WHITE`	Checks the submitted document is black and white copy
`EXPIRY`	Expiry check helps to ensure that documents remain valid and can help to avoid potential legal or financial issues that could arise from using outdated or invalid information.
`MRZ`	Checks for valid MRZ in passport
`PHOTO_SUBSTITUTION`	Checks whether the document is substituted with photo or not
`VISUAL_INTEGRITY`	Checks whether the document has been tampered with or not.

Sample Payload

{
    "verificationId": "hdgfhoiu23478y234buw",
    "externalRefId": "Sample123",
    "status": "DONE",
    "identityOwner": {
        "familyName": "Smith",
        "givenName": "John",
        "dateOfBirth": "1990-11-23",
        "email": "test@gsjkghskjg.com",
        "mobileNumber": "+61 000000000",
        "gender": "M"
    },
    "results": {
        "proofingOutcomes": [
            {
                "proofingStatus": "WARNING",
                "documents": [
                    {
                        "countryCode": "AUS",
                        "documentType": "DRIVERS_LICENCE",
                        "proofingTag": [
                            "IDENTITY_PROOFING"
                        ],
                        "documentDisplayName": "Australian Driver's Licence or Photo ID",
                        "category": "PRIMARY",
                        "documentClassificationCode": "DRIVERS_LICENCE.AUS.NSW.LEARNER",
                        "status": "WARNING",
                        "images": [
                            "https://api.au.truuth.id/identity-verification/v2/verifications/hdgfhoiu23478y234buw/documents/fb399eb6-e2a4-4de2-9159-50169a458dd0/images?pageId=0",
                            "https://api.au.truuth.id/identity-verification/v2/verifications/hdgfhoiu23478y234buw/documents/fb399eb6-e2a4-4de2-9159-50169a458dd0/images?pageId=1"
                        ],
                        "securityChecks": [
														{
                                "type": "dobMatch",
                                "name": "DOB Match",
                                "status": "PASS"
                            },
                            {
                                "type": "expiryCheck",
                                "name": "Expiry",
                                "status": "PASS"
                            },
                          	{
                                "type": "nameMatch",
                                "name": "Name Match",
                                "status": "PASS"
                            },
                          	{
                                type: 'irnMatch',
                                name: 'Irn Match',
                                status: "PASS"
                            },
                          	{
                                "type": "sourceCheck",
                                "name": "Official Source",
                                "status": "PASS"
                            },
                            {
                                "type": "allowedDocumentCheck",
                                "name": "Allowed Document",
                                "status": "PASS"
                            },
                            {
                                "type": "documentOcr",
                                "name": "Data Extraction",
                                "status": "PASS",
                                "score": 0.981
                            },
                            {
                                "type": "documentAuthenticity",
                                "name": "Authenticity",
                                "status": "WARNING",
                                "score": 0.7993188846912511,
                                "subChecks": [
                                    {
                                        "type": "TEXT_FEATURES",
                                        "name": "Text Features",
                                        "score": 1
                                    },
                                    {
                                        "type": "BLACK_WHITE",
                                        "name": "Black And White",
                                        "score": 0.9965985957813903
                                    },
                                    {
                                        "type": "EXPIRY",
                                        "name": "Expiry",
                                        "score": 1
                                    },
                                    {
                                        "type": "PHOTO_SUBSTITUTION",
                                        "name": "Photo Substitution",
                                        "score": 0.3
                                    },
                                    {
                                        "type": "VISUAL_INTEGRITY",
                                        "name": "Visual Integrity",
                                        "score": 0.9999958276748657
                                    },
                                    {
                                        "type": "MRZ",
                                        "name": "MRZ",
                                        "score": 1
                                    },
                                ]
                            },
                            {
                                "type": "faceMatch",
                                "name": "Face Match",
                                "status": "PASS",
                                "score": 0.9978362274169922
                            },
                            {
                                "type": "dataEditCheck",
                                "name": "Data Edit",
                                "status": "PASS",
                                "score": 1
                            },
                          	{
                                "name": "Document Recency",
                                "type": "documentRecencyCheck",
                                "status": "PASS"
                            }
                        ],
                        "documentData": [
                            {
                                "key": "givenName",
                                "value": "John",
                                "confidence": 0.995
                            },
                            {
                                "key": "middleName",
                                "value": "",
                                "confidence": 0.995
                            },
                            {
                                "key": "familyName",
                                "value": "Smith",
                                "confidence": 0.995
                            },
                            {
                                "key": "state",
                                "value": "NSW",
                                "confidence": 1
                            },
                            {
                                "key": "dateOfExpiry",
                                "value": "2033-03-23",
                                "confidence": 0.994
                            },
                            {
                                "key": "dateOfBirth",
                                "value": "1990-11-23",
                                "confidence": 0.997
                            },
                            {
                                "key": "addressLine1",
                                "value": "13 EMPIRE CCT",
                                "confidence": 0.996
                            },
                            {
                                "key": "addressLine2",
                                "value": "PENRITH NSW 2750   ",
                                "confidence": 0.996
                            },
                            {
                                "key": "cardNumber",
                                "value": "8393843878",
                                "confidence": 0.992
                            },
                            {
                                "key": "licenceNumber",
                                "value": "09383839282",
                                "confidence": 0.981
                            },
                            {
                                "key": "licenceClass",
                                "value": "C LRN",
                                "confidence": 0.996
                            }
                        ]
                    }
                ],
                "userBehaviourChecks": [
                    {
                        "name": "T&C",
                        "type": "t&c",
                        "status": "PASS"
                    },
                    {
                        "type": "docSubmissionCheck",
                        "name": "Doc Submission",
                        "status": "PASS"
                    }
                ],
                "proofingType": {
                    "code": "IDENTITY_PROOFING",
                    "name": "Identity Proofing"
                }
            }
        ],
        "otherCheckOutcomes": [
            {
                "type": "repeatUserFraudCheck",
                "name": "Repeat User Fraud Check",
                "status": "WARNING",
                "subChecks": [
                    {
                        "type": "FACE_MISMATCH",
                        "name": "Different Face (ID Doc & Selfie)",
                        "status": "PASS"
                    },
                    {
                        "type": "SAME_FACE_DIFF_PII",
                        "name": "Same face , different PII",
                        "status": "PASS"
                    },
                    {
                        "type": "DIFF_FACE_SAME_PII",
                        "name": "Different face, same PII",
                        "status": "PASS"
                    },
                    {
                        "type": "DIFF_FACE_DIFF_PII_SAME_DOC",
                        "name": "Different face, same ID",
                        "status": "PASS"
                    },
                    {
                        "type": "SAME_FACE_DIFF_EMAIL",
                        "name": "Same face , different email",
                        "status": "WARNING"
                    },
                    {
                        "type": "DIFF_FACE_SAME_EMAIL",
                        "name": "Different face, same email",
                        "status": "PASS"
                    }
                ]
            }
        ],
        "faceImage": "https://api.au.truuth.id/identity-verification/v2/verifications/hdgfhoiu23478y234buw/images/faces",
        "reports": [
            {
                "name": "Identity Verification Report",
                "type": "IDV_VERIFICATION_REPORT_V2",
                "reportUrl": "https://api.au.truuth.id/identity-verification/v2/verifications/hdgfhoiu23478y234buw/report",
                "details": {
                    "status": "IN_PROGRESS"
                }
            },
            {
                "type": "FRAUD_CHECK_REPORT",
                "name": "Fraud Check",
                "reportUrl": "https://api.au.truuth.id/identity-verification/v2/verifications/3RsyulLlCJIaMpT37ixj/fraud-check-report",
                "details": {
                    "status": "IN_PROGRESS"
                }
            }
        ]
    },
    "createdAt": "2025-02-25T07:20:59.946Z"
}

Updated 25 days ago