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 our API references page.

• Resend Verification Invite API

In the event that the customer was not able to find the original invitation email generated by the "Send Verification invite API". This API can resend 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 our API references page.

• 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]

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].

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 provide below details to Truuth sales team,

• Webhook Url
• we support basic authentication types, so give us a username and password

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 theIdentity Owner section below for more details
results.proofingOutcomes	Array	Please refer to theProofing 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	String	IDENTITY_PROOFING ADDRESS_PROOFING
documents	Array	Returns one array for each document scanned. Please refer to theResult Document Details section below for more details
userBehaviourChecks	Array	Returns an array of different behavioural checks. Please refer User Behaviour Checks section
reports	Object	Proofing outcome report available to download. Please refer Report section for definition

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
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 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
documentId	String	Unique identifier assigned to this document.
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 FAIL

Identity Document Data - Object definition

Property	Type	Description
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	expiryCheck faceMatch nameMatch dobMatch sourceCheck documentAuthenticity dataEditCheck dataExtractionCheck
name	String	Friendly name
status	String	PASS FAIL WARNING
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
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

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 thedocumentAuthenticity 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.