Step 7: Retrieve Results

Purpose: This endpoint will provide the final results once the transaction completes. The response will have match signals per Name and Address fields and notify if the individual is verified.

It may take a few minutes for the transaction to complete. Once the results are available, the callback status updates to “Success”.

The Transaction Record ID (TRID) will be sent to the callback URL provided.

User-experience: The end-user does not need to wait for the transaction to complete. It can run in the background while the user explores your product/platform.

Sample Request

GET /verifications/v1/transactionrecord/20274a8a-3250-1095-abd8-21f89188e204 HTTP/1.1
Host: <<endpointLink>>
Content-Type: application/json
Authorization: Basic <auth>

Path Parameters:

  • id - The TransactionRecordID from the callbackURL status update.
    • Required
    • Type: string

Sample Response

{   
   "TransactionID": "f6332624-0260-489a-87c3-d14502e9e57c",
    "UploadedDt": "2022-05-04T21:38:13",
    "CountryCode": "CA",
    "ProductName": "Identity Verification",
    "Record": {
        "TransactionRecordID": "200b3a6f-0dee-4a6a-21aa-0518de9d7576",
        "RecordStatus": "match",
        "DatasourceResults": [
            {
                "DatasourceName": "UtilityID",
                "DatasourceFields": [
                    {
                        "FieldName": "FirstGivenName",
                        "Status": "match"
                    },
                    {
                        "FieldName": "FirstSurName",
                        "Status": "match"
                    },
                    {
                        "FieldName": "Address1",
                        "Status": "match"
                    },
                    {
                        "FieldName": "City",
                        "Status": "match"
                    },
                    {
                        "FieldName": "StateProvinceCode",
                        "Status": "match"
                    },
                    {
                        "FieldName": "PostalCode",
                        "Status": "nomatch"
                    },
                    {
                        "FieldName": "FirstInitial",
                        "Status": "match"
                    },
                    {
                        "FieldName": "UnitNumber",
                        "Status": "missing"
                    },
                    {
                        "FieldName": "BuildingNumber",
                        "Status": "match"
                    },
                    {
                        "FieldName": "StreetName",
                        "Status": "match"
                    },
                    {
                        "FieldName": "StreetType",
                        "Status": "match"
                    }
                ],
                "AppendedFields": [],
                "Errors": [],
                "FieldGroups": []
            }
        ],
        "Errors": [],
        "Rule": {
            "RuleName": "Category 3 KYC v3",
            "Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored"
        }
    },
    "Errors": []
}