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.

PropertyTypeDescription
verificationIdStringunique verification identifier
externalRefIdStringReference identifier for easy identification
statusStringEnum:
DONE - Verification is completed
IN_PROGRESS - User is still submitting the document
PROCESSING - Waiting for verification outcome
identityOwnerObjectPlease refer to theIdentity Owner section below for more details
results.proofingOutcomesArrayPlease refer to theProofing Outcome section below for more details
results.faceImageStringFace images URL to retrieve the face image
results.reportsArrayAdditional 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
createdAtStringThe verification created date-time in YYYY-MM-DDThh:mm:ss:msZ format ie. 1998-12-23T11:47:15.140Z

Identity Owner

PropertyTypeDescription
givenNamestringGiven name of the customer from identity documents
familyNamestringFamily name of the customer from identity documents
middleNamestringMiddle name of the customer from identity documents
dateOfBirthstring"Date of birth" of the customer from identity documents
emailstringEmail of the invited user
genderstringPossible values are "M", "F"
mobileNumberstringMobile number of the invited user

Proofing Outcome

PropertyTypeDescription
statusStringPossible states: PASS FAIL
proofingTypeStringIDENTITY_PROOFING
ADDRESS_PROOFING
documentsArrayReturns one array for each document scanned. Please refer to theResult Document Details section below for more details
userBehaviourChecksArrayReturns an array of different behavioural checks. Please refer User Behaviour Checks section
proofingReportObjectProofing outcome report available to download.

Please refer Proofing Report section for definition

User Behaviour Checks

This object contains details of different user behaviour checks

PropertyTypeDescription
typeStringsecurity check type
liveness
docSubmissionCheck t&c
nameStringLiveness Doc Submission Check T&C
statusStringPASS FAIL
scorenumberLiveness score range between 0 to 1

Note: score is applicable only for Liveness

Proofing Report

PropertyTypeDescription
reportUrlStringcan be used to download the verification outcome in pdf format.

Authentication Type: BASIC
details.statusStringIN_PROGRESS DONE ERROR
details.statusReasonStringReasons for failure can be added here

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):

PropertyTypeDescription
typeStringSANCTIONS_AND_PEP_REPORT
AUS_BUSINESS_VERIFICATION_REPORT
reportUrlStringcan be used to download the verification outcome in pdf format.

Authentication Type: BASIC
details.statusStringIN_PROGRESS DONE ERROR
details.statusReasonStringMATCH NO_MATCH

Result Document Details

This object contains details for an individual document.

PropertyTypeDescription
documentTypeStringPASSPORT DRIVERS LICENCE MEDICARE
documentIdStringUnique identifier assigned to this document.
documentDisplayNameStringUser-friendly name is given in the proofing framework
documentClassificationCodeStringUsed 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
categoryStringDocument 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
documentDataObjectIdentity document extract details. Please refer to the Identity Document Data section below for more information
countryCodeString"AUS"
securityChecksArrayDocument security check status. Please refer Security check details section below for more details
imagesArrayDocument images Url. Please refer Identity Document Image Details section below for more details
statusStringPossible states: PASS FAIL

Identity Document Data - Object definition

PropertyTypeDescription
valueStringValue of the document data field.
confidenceNumberThe data field extracts the confidence score. min: 0, max: 1

Security Check Details

This object contains details of different user behaviour checks

PropertyTypeDescription
typeStringexpiryCheck
faceMatch
nameMatch
dobMatch
sourceCheck
documentAuthenticity
dataEditCheck
dataExtractionCheck
nameStringFriendly name
statusStringPASS
FAIL
WARNING
scorenumberScore is applicable only for documentAuthenticity.
min: 0, max: 1
subChecksArraySub checks are applicable only for documentAuthenticity

Available Security checks

PropertyDescription
expiryCheckCheck if the document provided is expired or not
faceMatchEnsures the selfie and provided identity document face matches or not
nameMatchEnsures the name of all documents provided is matching or not
dobMatchEnsures the dob of all documents provided is matching or not

NA will be returned for a document which doesn't have dateOfBirth.
sourceCheckVerifies 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.
irnMatchVerifies the provided individual reference number matches one of the names on the medicare card
documentAuthenticityVerifies the authenticity of the document
documentOcrVerifies the document extract information
dataEditCheckThis check gives the visibility of whether the user edited the data or not when the review edit feature is turned On
documentRecencyCheckTo ensure whether the document provided is recent or not

Authenticity Sub-Check Details

PropertyTypeDescription
typeStringTEXT_FEATURES
BLACK_WHITE
EXPIRY
nameStringFriendly name
scorenumberThe score is applicable only to thedocumentAuthenticity sub-check.
min: 0, max: 1

Available Authenticity Sub-Check

PropertyDescription
TEXT_FEATURESText feature classification can be used to eliminate fake documents by identifying patterns or features in the document that are inconsistent with authentic documents.
BLACK_WHITEChecks the submitted document is black and white copy
EXPIRYExpiry 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.
MRZChecks for valid MRZ in passport
PHOTO_SUBSTITUTIONChecks whether the document is substituted with photo or not