HomeDocumentationKnowledge HubSupportRelease NotesSearch Box
Documentation

Verify

post
https://api.trulioo.com/verifications/v1/verify

Calling this method will perform a verification. You can query configuration to get what fields are available to you in each country.
It is also possible to get sample requests from the customer portal.

Sandbox Accounts

If you are configured for a sandbox account make sure to call Get Test Entities to get test data for a country you want to try. Sandbox accounts only use these test entities and so trying to verify with any other data will result in no matches being found.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
VerifyRequest request = new VerifyRequest()
{
    AcceptTruliooTermsAndConditions = true,
    Demo = true,
    CleansedAddress = false,
    ConfigurationName = "Identity Verification",
    ConsentForDataSources = new string[]
        {
            "Australia Driver License",
            "Australia Passport",
            "Birth Registry",
            "Visa Verification",
            "DVS Driver License Search",
            "DVS Medicare Search",
            "DVS Passport Search",
            "DVS Visa Search",
            "DVS ImmiCard Search",
            "DVS Citizenship Certificate Search",
            "DVS Certificate of Registration by Descent Search",
            "Credit Agency"
        },
    CountryCode = "AU",
    DataFields = new DataFields()
    {
        PersonInfo = new PersonInfo()
        {
            FirstGivenName = "John",
            MiddleName = "Henry",
            FirstSurName = "Smith",
            DayOfBirth = 5,
            MonthOfBirth = 3,
            YearOfBirth = 1983,
            Gender = "M"
        },
        Location = new Location()
        {
            BuildingNumber = "10",
            UnitNumber = "3",
            StreetName = "Lawford",
            StreetType = "st",
            Suburb = "Doncaster",
            StateProvinceCode = "VIC",
            PostalCode = "3108"
        },
        Communication = new Communication()
        {
            Telephone = "03 9896 8785",
            EmailAddress = "[email protected]"
        },
        DriverLicence = new DriverLicence()
        {
            Number = "076310691",
            State = "VIC",
            DayOfExpiry = 3,
            MonthOfExpiry = 4,
            YearOfExpiry = 2021
        },
        NationalIds = new NationalId[]
        {
            new NationalId()
            {
                Number = "5643513953",
                Type = "Health"
            }
        },
        Passport = new Passport()
        {
            Mrz1 = "P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<",
            Mrz2 = "N1236548<1AUS8303052359438740809<<<<<<<<<<54",
            Number = "N1236548",
            DayOfExpiry = 5,
            MonthOfExpiry = 12,
            YearOfExpiry = 2018
        },
        CountrySpecific = new CountrySpecific()
        {
            { "AU",
                new Dictionary<string, string>()
                {
                    { "AuImmiCardNumber", "EIS123456" },
                    { "CitizenshipAcquisitionDay", "15" },
                    { "CitizenshipAcquisitionMonth", "4" },
                    { "CitizenshipAcquisitionYear", "1987" },
                    { "CountryOfBirth", "Australia" },
                    { "FamilyNameAtBirth", "Smith" },
                    { "MedicareColor", "Blue" },
                    { "MedicareMonthOfExpiry", "12" },
                    { "MedicareReference", "2" },
                    { "MedicareYearOfExpiry", "2017" },
                    { "PassportCountry", "Australia" },
                    { "PlaceOfBirth", "Melbourne" },
                    { "RegistrationNumber", "565659" },
                    { "RegistrationState", "NSW" },
                    { "StockNumber", "ACD1234567" }
                }
            }
        }
    }
};
            
VerifyResult result = await truliooClient.Verification
    .VerifyAsync(request);
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
VerifyRequest request = new VerifyRequest()
    .acceptTruliooTermsAndConditions(Boolean.TRUE)
    .demo(true)
    .cleansedAddress(false)
    .configurationName("Identity Verification")
    .countryCode("AU")
    .consentForDataSources(new ArrayList<>(Arrays.asList(
        "Australia Driver License",
        "Australia Passport",
        "Birth Registry",
        "Visa Verification",
        "DVS Driver License Search",
        "DVS Medicare Search",
        "DVS Passport Search",
        "DVS Visa Search",
        "DVS ImmiCard Search",
        "DVS Citizenship Certificate Search",
        "DVS Certificate of Registration by Descent Search",
        "Credit Agency")))
    .dataFields(new DataFields()
        .personInfo(new PersonInfo()
            .firstGivenName("John")
            .middleName("Henry")
            .firstSurName("Smith")
            .yearOfBirth(1983)
            .monthOfBirth(3)
            .dayOfBirth(5)
            .gender("M"))
        .location(new Location()
            .postalCode("3108")
            .buildingNumber("10")
            .unitNumber("3")
            .streetName("Lawford")
            .streetType("st")
            .suburb("Doncaster")
            .stateProvinceCode("VIC")
            .city("Vancouver"))
        .communication(new Communication()
            .telephone("03 9896 8785")
            .emailAddress("[email protected]"))
            .driverLicence(new DriverLicence()
            .number("076310691")
            .state("VIC")
            .dayOfExpiry(3)
            .monthOfExpiry(4)
            .yearOfExpiry(2021))
        .nationalIds(Arrays.asList(new NationalId()
            .number("5643513953")
            .type("Health")))
        .passport(new Passport()
            .mrz1("P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<")
            .mrz2("N1236548<1AUS8303052359438740809<<<<<<<<<<54")
            .number("N1236548")
            .dayOfExpiry(5)
            .monthOfExpiry(12)
            .yearOfExpiry(2018))
        .countrySpecific(new HashMap<String, Map<String, String>>(){{
            put("AU", new HashMap<String, String>(){{
                put("AuImmiCardNumber", "EIS123456");
                put("CitizenshipAcquisitionDay", "15");
                put("CitizenshipAcquisitionMonth", "4");
                put("CitizenshipAcquisitionYear", "1987");
                put("CountryOfBirth", "Australia");
                put("FamilyNameAtBirth", "Smith");
                put("MedicareColor", "Blue");
                put("MedicareMonthOfExpiry", "12");
                put("MedicareReference", "2");
                put("MedicareYearOfExpiry", "2017");
                put("PassportCountry", "Australia");
                put("PlaceOfBirth", "Melbourne");
                put("RegistrationNumber", "565659");
                put("RegistrationState", "NSW");
                put("StockNumber", "ACD1234567");}});
}}));

//verify
VerifyResult result = verificationClient.verify(request);

//verifyAsync
verificationClient.verifyAsync(request, new ApiCallback<VerifyResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(VerifyResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Body Params

The verification call for the Normalized API is a POST method call

boolean

Indicate that Trulioo terms and conditions are accepted.
The Verification request will be executed only if the value of this header is passed as 'true'.

string
length between 0 and 2083

Including this field will cause the transaction to follow our asynchronous flow, detailed here.
Please do not include this field if you do not wish to trigger the asynchronous transaction flow.

int32

If set, Trulioo will try to update the client synchronously within the timeout in seconds. If failed to accomplish, the transaction will be canceled.

string
length between 0 and 45

Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported.
Default value will be "Identity Verification"

ConsentForDataSources
array of strings

Some datasources require your customer provide consent to access them. For each datasource that requires consent, send the required string if your customer has provided it. A list of these required strings for a country can be gotten by the Get Consents call. If consent is not provided the datasource will not be queried.

ConsentForDataSources
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

string

Use this field to send any internal reference ID to Global Gateway. It will be contained in the response so it is simple to link Trulioo's API to your system.

DataFields
object
required

The data field name-value pairs for the data elements on which the verification is to be performed

boolean
Defaults to false

To return additional appended fields of watch list hit details in the response

Responses

400

Your request could not be processed, there should be more details in the response.

401

The user name and password you provided is not valid or you are using an account not configured to be an API user.

408

The request took longer to process than we waited.

415

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

500

An error happened on the server without a specific message.

Updated 9 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago