KYC verification of individuals (AUS) - guide

This page contains only params relevant for the specific example. For a complete list of params for this API call visit this page.

Supplying additional verification

The initially provided information will not always be sufficient to verify the individual. In this case, you can submit a new verification with additional information, or append the information to the current verification by using the

userId

parameter.

In the examples bellow we will add government ID documents to provide more verification sources:

Attempt #1 - basic details only
Response #1 - rejected (verification score: 0)
Attempt #2 - add driver licence
Response #2 - rejected (verification score: 60)
Attempt #3 - add passport
Response #3 - verified (verification score: 130)

Caveat

When the userId parameter is present in KYC verifications, subsequent verifications with the same userId are regarded as additions to the previous verification. If you use the

userId

parameter, be careful that it is unique per user. Once a userId has gotten to a successful verification, all further verification attempts with that userId (even if the data is incorrect) will return an (incorrect) successful verification because they are regarded as a supplementation to the older verification.

Test values

You can find the government ID document test values we will be using in the examples here.

Verification attempt 1

{
    "metadata_version": "4",
    "metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
    "metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
    "metadata_userId": "your-unique-user-id",
    
    "type": "individual",
    "fields": {
        "country": "AUS",
        "firstName": "Jane",
        "lastName": "Citizen",
        "gender": "female",
        "dateOfBirth": "20/10/1980",
        "unitNumber": "1",
        "streetNumber": "95",
        "streetName": "Lennox",
        "streetType": "Street",
        "suburb": "CASINO",
        "postcode": "2470",
        "state": "NSW",
        "email": "email@gmail.com"
    }
}

Verification response 1

{
    "name": "Jane Citizen",
    "verificationStatus": "rejected",
    "verificationScore": 0,
    "verificationUuid": "1d965e16-3ef3-4afb-93e4-0fc640802058",
    "submissionStatus": "submitted",
    "userId": "your-unique-user-id",
    "timestamp": 1592453060,
    "inWatchLists": [
        {
            "method": "background",
            "name": "Australian Department of Foreign Affairs and Trade (DFAT)",
            "officialUrl": "https://dfat.gov.au/international-relations/security/sanctions/pages/sanctions.aspx"
        },
      	// ... other results omitted
    ],
    "outOfWatchLists": [
        {
            "method": "background",
            "name": "International Criminal Police Organization (INTERPOL) Wanted Persons",
            "officialUrl": "https://www.interpol.int/How-we-work/Notices/View-Red-Notices"
        },
        // ... other result omitted
    ]
}

Verification attempt 2

{
    "metadata_version": "4",
    "metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
    "metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
    "metadata_userId": "your-unique-user-id",
    
    "type": "individual",
    "fields": {
        "country": "AUS",
        "firstName": "Jane",
        "lastName": "Citizen",
        "gender": "female",
        "dateOfBirth": "20/10/1980",
        "unitNumber": "1",
        "streetNumber": "95",
        "streetName": "Lennox",
        "streetType": "Street",
        "suburb": "CASINO",
        "postcode": "2470",
        "state": "NSW",
        "email": "email@gmail.com",
        
        // new details
        "driversLicenceNumber": "11111111",
        "driversLicenceState": "NSW"
    }
}

Verification response 2

{
    "name": "Jane Citizen",
    "verificationStatus": "rejected",
    "verificationScore": 60,
    "verificationUuid": "91ad96a1-f2a5-41f1-a007-facfb58ffc50",
    "submissionStatus": "submitted",
    "userId": "your-unique-user-id",
    "timestamp": 1592453554,
    "inWatchLists": [
        {
            "method": "background",
            "name": "Australian Department of Foreign Affairs and Trade (DFAT)",
            "officialUrl": "https://dfat.gov.au/international-relations/security/sanctions/pages/sanctions.aspx"
        },
      	// ... other results omitted
    ],
    "outOfWatchLists": [
        {
            "method": "background",
            "name": "International Criminal Police Organization (INTERPOL) Wanted Persons",
            "officialUrl": "https://www.interpol.int/How-we-work/Notices/View-Red-Notices"
        },
        // ... other result omitted
    ]
}

Verification attempt 3

{
    "metadata_version": "4",
    "metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
    "metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
    "metadata_userId": "your-unique-user-id",
    
    "type": "individual",
    "fields": {
        "country": "AUS",
        "firstName": "Jane",
        "lastName": "Citizen",
        "gender": "female",
        "dateOfBirth": "20/10/1980",
        "unitNumber": "1",
        "streetNumber": "95",
        "streetName": "Lennox",
        "streetType": "Street",
        "suburb": "CASINO",
        "postcode": "2470",
        "state": "NSW",
        "email": "email@gmail.com",
        "driversLicenceNumber": "11111111",
        "driversLicenceState": "NSW",
        
        // new details
        "passportNumber": 'A1111111',
        "passportCountryOfIssue": "AUS"
    }
}

Verification response 3

{
    "name": "Jane Citizen",
    "verificationStatus": "verified",
    "verificationScore": 130,
    "verificationUuid": "daca2012-a2ed-4cd4-b5ea-bc697afe8e8d",
    "submissionStatus": "submitted",
    "userId": "your-unique-user-id",
    "timestamp": 1592453708,
    "inWatchLists": [
        {
            "method": "background",
            "name": "Australian Department of Foreign Affairs and Trade (DFAT)",
            "officialUrl": "https://dfat.gov.au/international-relations/security/sanctions/pages/sanctions.aspx"
        },
      	// ... other results omitted
    ],
    "outOfWatchLists": [
        {
            "method": "background",
            "name": "International Criminal Police Organization (INTERPOL) Wanted Persons",
            "officialUrl": "https://www.interpol.int/How-we-work/Notices/View-Red-Notices"
        },
        // ... other result omitted
    ]
}