This document has been created to provide you a concise outline of truuth API’s in an interactive format that allows easy data access to our methods and code to allow straight forward and fast integration of our services into your own systems.
\nThis page is dynamically updated as our platform evolves utilising the Postman API documentation tool so that developers can with one click run the API’s in Postman (see icon on top right).
\ntruuth mission is to build the worlds most secure and accurate digital identity service.
\nTo achieve this we are building our truuth identity platform that empowers enterprises with a flexible suite of integrated services to provide the most secure and frictionless experiences to their customers for a range of use cases from customer on-boarding to ongoing authentication. Our www.truuth.id website outlines our product offerings.
\nOur API’s are matched to your business use cases. Truuth offers both end to end API’s such as identity verification and API’s 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 customer solutions.
\nTruuth provides an identity verification API that covers the following steps:
\nYes if you are looking for the most accurate & trusted identity service at the right price and if you are looking to ‘mix & match’ step by step API’s that fit with your own solutions.
\nWe welcome our enterprise customers to explore truuth API’s in our sandbox before proceeding with an integration and any commercial commitments. A user can create a free test ‘sandbox’ account enabling a developer to gather first impressions of the truuth services before committing to a subscription plan.
\nPlease contact us by sending an email to support@truuth.id for any questions on truuth APIs and to request access to the sandbox (we will provide API authentication keys), receive information on service pricing and to onboard onto our live environment. We can also provide information on the further range of API use cases that are soon available and to hear your requests.
\nTo send an authenticated request to the truuth API you must provide your API key and secret in Authorization header as Basic Authentication within each request.
\nAuthorization: {{vault:basic-auth}}(Required) The api key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.api.truuth.id/document-management/v1/document-management/v1/supported-documents","description":"This function provides the supported document types so automatic update as further document types are added.
\nThe type of the document that templates is designed for
\n","type":"text/plain"},"key":"document-type","value":"The code of country that the template is designed for
\n","type":"text/plain"},"key":"country-code","value":"(Required) The api key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"AUS\",\n \"documentType\": \"Extracts data from a set of document types in a defined response format relative to each document type. Each document type has had templates created that match data to output fields for easy use within your customer systems.
\n","_postman_id":"210b02ff-bf8d-41ef-ae76-71595dfade46"},{"name":"Authenticity Verification","item":[{"name":"Authenticity Verification V1","id":"41b237e2-7c9a-4f5f-8efb-9eab5022ca9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"[if gte mso 9]>
\n[if gte mso 9]>
\nNormal
0
false
false
false
EN-AU
X-NONE
X-NONE
[if gte mso 9]>
\n[if gte mso 10]>
\nStartFragme
\nNote: The authenticityChecks object is a dynamic array and depending on whether a particular check is applicable to a document it will be found in the response.
\nEndFragment
\n","urlObject":{"path":["document-management","v2","authenticity","verify"],"host":["https://sandbox.api.truuth.id/document-management/v1"],"query":[],"variable":[]}},"response":[{"id":"04f47737-240c-4abc-a7af-924438b68920","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicTakes an image of a document and returns a score from 0 to 1 representing the authenticity of that document. Currently supported documents are:
\nConfidence values should be interpreted as follows:
\n","_postman_id":"f367e3cf-0ff6-4496-a751-126f79b0a44a"},{"name":"Document Face Match","item":[{"name":"Match the selfie with the Photo ID","id":"150ed6c7-0b33-48de-a718-2a9c14acca86","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{api-key}}","description":"(Required) The access key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"photoId\": {\n \"mimeType\": \"Compares two facial image files and returns a code & description either confirming the match or giving an error message.\n(For example the enterprise system extracts these two images from a selfie and ID document and passes them to the API)
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"7aadb42f-9dca-4eaf-b81d-3e9a406ba34f"},{"name":"Identity Verification","item":[{"name":"Callback for identity verification [Legacy]","item":[],"id":"aa831951-5b3d-485b-8f3d-8ede0e71b62d","description":"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.
\nThe following parameters are posted to your callback URL for Identity verification.
\nIf the result is FAIL then we need to supply the following failure reasons (NB: it is possible to have more than one reason):
\nThis object contains details for an liveness.
\nThis object contains details for an individual document.
\nPlease refer Identity Document Data - Object definition section below for more details
Please refer Identity Document Data - Object definition section below for more details
Please refer Identity Document Data - Object definition section below for more details
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.
\nThe following parameters are posted to your callback URL for Identity verification.
\nThis object contains details of different user behaviour checks
\nIf the result is FAIL then we need to supply the following failure reasons (NB: it is possible to have more than one reason):
\nThis object contains details for an individual document.
\nThis object contains details of different user behaviour checks
\n(Required) The access key and secret associated with your account
\n","key":"Authorization","type":"text","value":"Basic {{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"Sends an invitation email containing a URL to a customer to start their identity verification process. Please note this is distinct from the Create verification endpoint below, which returns the URL alone for you to send to the customer.
The following query string parameters will be attached to the redirectUrl:
In the event of an error, one of the following error codes are sent to the client web app via redirectUrl:
\n(Required) The access key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"gunase29@gmail.com\",\n \"familyName\": \"Test\",\n \"givenName\": \"Test\",\n \"middleName\": \"Create the verification record and get the invite URL which can be used to send to the customer to start the verification process. Please note, this endpoint returns the URL only. If you need us to send an email to the customer on your behalf, please use the Invite customer endpoint.
The following query string parameters will be attached to the redirectUrl:
In the event of an error, one of the following error codes are sent to the client web app via redirectUrl:
\n(Required) The access key and secret associated with your account
\n","key":"Authorization","type":"text","value":"Basic {{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://sandbox.api.truuth.id/document-management/v1/identity-verification/v1/verifications/:verificationId/documents/:documentType/images?pageId=0","description":"Download the document image in base64 format. Document image URL will be provided as part of the callback result.
(Required) The access key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.api.truuth.id/document-management/v1/identity-verification/v1/verifications/:verificationId/faces","description":"Download the face image in base64 format. Face image URL will be provided as part of the callback result.
\nThis service initiates an identity verification process and returns the resulting data through a callback service.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"6fe13897-6f3f-4d73-8031-48bf7d174777"},{"name":"Invoice Parser","item":[{"name":"Submit invoice request","id":"b1196372-e694-4423-8efe-c8e1bbe6f828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{api-key}}","description":"(Required) The access key and secret associated with your account
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceUrl\": \"https://myaccount.blob.core.windows.net/invoices/VeterinaryClinic.pdf?sv=2012-02-12&st=2009-02-09&se=2009-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d\",\n \"invoiceName\": \"PalmyraVeterinary.pdf\"\n}"},"url":"https://sandbox.api.truuth.id/document-management/v1/invoice-parser/v1/invoices/submit","description":"Submit invoice requests to parse documents and extracts invoice OCR data
\n(Required) The access key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.api.truuth.id/document-management/v1/invoice-parser/v1/invoices/:invoiceId","description":"Retrieve invoice results
\n(Required) The Id of the invoice request
\n","type":"text/plain"},"type":"any","value":"(Required) The access key and secret associated with your account
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://sandbox.api.truuth.id/document-management/v1/invoice-parser/v1/invoices/healthy","description":"Retrieve health status
\nThis service initiates a invoice parsing process to extract an invoice data from submitted document and returns the resulting data through a callback service.
\nAnd also service can return invoice results from system by invoice id.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6e20b437-d1f0-4177-8fc5-808caab32b97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1269d6d8-1ada-4181-a256-5e2ecc064b41","type":"text/javascript","exec":[""]}}],"_postman_id":"c7f863ea-3adf-4c04-aac5-b5f4c50d2e30"}],"event":[{"listen":"prerequest","script":{"id":"b354bdc1-0902-44bd-af5e-9eaa16ad6ad2","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ed56e524-3b33-4e47-8104-0d8da1b4d15f","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://sandbox.api.truuth.id/document-management/v1"}]}