Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
verifications-api.tiller-verify.com/api/{version}/runAsync is true, a correlationId is returned, which must be used to fetch the results via the GET /api/v1/verifications/{correlationId} endpoint.client_id: Your client ID, provided by Tiller.https://verifications-auth.tiller-verify.com/connect/tokencurl --location 'https://verify-auth.tiller-verify.com/connect/token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=VerificationsAPI' \
--data-urlencode 'client_id=CLIENT_ID' \
--data-urlencode 'client_secret=CLIENT_SECRET'import requests
url = "https://verifications-auth.tiller-verify.com/connect/token"
payload = {'grant_type':'client_credentials',
'scope': 'VerificationsAPI',
'client_id': CLIENT_ID,
'client_secret': CLIENT_SECRET
}
headers = {
'Accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.request("POST", AUTH_URL, headers=headers, data=payload)
print(response.text)
{
"access_token": "eyJhbGciOiJS...",
"expires_in": 600,
"token_type": "Bearer",
"scope": "VerificationsAPI"
}POST https://verifications-api.tiller-verify.com/api/v1/verifications{
"externalReferenceId": "YOUR_REQUEST_REFERENCE",
"options": {
"runAsync": false,
"mock": true
},
"checks": [
{
"checkTypeId": 1,
"externalCheckReferenceId": "YOUR_CHECK_REFERENCE",
"maximumSources": 3,
"CheckMethod": 1,
"matchesRequired": 1
}
],
"profile": {
"titleId": 1,
"genderTypeId": 1,
"firstName": "John",
"middleName": "Charles",
"lastName": "Smith",
"dateOfBirth": "1980-06-12",
"currentAddress": {
"structured": {
"flatApartmentSubBuilding": "10A",
"BuildingNumber": "50",
"BuildingName": "Example House",
"RoadStreet": "Example Street",
"townCity": "Exampleton",
"District": "Exampleshire",
"StateProvinceName": "Example",
"StateProvinceCode": "EG",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2020-01-03T00:00:00"
}
}
}
}curl -X POST "https://verifications-api.tiller-verify.com/api/v1/verifications" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"externalReferenceId": "YOUR_REQUEST_REFERENCE",
"options": {
"runAsync": false,
"mock": true
},
"checks": [
{
"checkTypeId": 1,
"externalCheckReferenceId": "YOUR_CHECK_REFERENCE",
"maximumSources": 3,
"CheckMethod": 1,
"matchesRequired": 1
}
],
"profile": {
"titleId": 1,
"genderTypeId": 1,
"firstName": "John",
"middleName": "Charles",
"lastName": "Smith",
"dateOfBirth": "1980-06-12",
"currentAddress": {
"structured": {
"flatApartmentSubBuilding": "10A",
"BuildingNumber": "50",
"BuildingName": "Example House",
"RoadStreet": "Example Street",
"townCity": "Exampleton",
"District": "Exampleshire",
"StateProvinceName": "Example",
"StateProvinceCode": "EG",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2020-01-03T00:00:00"
}
}
}
}'import requests
# API endpoint
url = "https://verifications-api.tiller-verify.com/api/v1/verifications"
# Headers
headers = {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
}
# Payload
payload = {
"externalReferenceId": "YOUR_REQUEST_REFERENCE",
"options": {
"runAsync": False,
"mock": True
},
"checks": [
{
"checkTypeId": 1,
"externalCheckReferenceId": "YOUR_CHECK_REFERENCE",
"maximumSources": 3,
"CheckMethod": 1,
"matchesRequired": 1
}
],
"profile": {
"titleId": 1,
"genderTypeId": 1,
"firstName": "John",
"middleName": "Charles",
"lastName": "Smith",
"dateOfBirth": "1980-06-12",
"currentAddress": {
"structured": {
"flatApartmentSubBuilding": "10A",
"BuildingNumber": "50",
"BuildingName": "Example House",
"RoadStreet": "Example Street",
"townCity": "Exampleton",
"District": "Exampleshire",
"StateProvinceName": "Example",
"StateProvinceCode": "EG",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2020-01-03T00:00:00"
}
}
}
}
# Request
response = requests.post(url, headers=headers, json=payload)
# Response
print(response.json())
{
"ValidationErrors": {
"Profile.FirstName": [
"FirstName: field is required"
],
"Profile.CurrentAddress.Structured.CountryCode": [
"CountryCode: field is required"
]
},
"Type": null,
"Title": "Request Validation Error",
"Status": 400,
"Detail": "One or more validation errors occurred. See ValidationErrors for details.",
"Instance": "urn:tillertechverifications:badrequest:43f3e884-c791-4c39-a05d-351d8ed162b6",
"Extensions": {}
}
curl --location 'https://verify-auth.tiller-verify.com/connect/token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=VerificationsAPI' \
--data-urlencode 'client_id=CLIENT_ID' \
--data-urlencode 'client_secret=CLIENT_SECRET'import requests
url = "https://verifications-auth.tiller-verify.com/connect/token"
payload = {'grant_type':'client_credentials',
'scope': 'VerificationsAPI',
'client_id': CLIENT_ID,
'client_secret': CLIENT_SECRET
}
headers = {
'Accept': 'application/json',
'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.request("POST", AUTH_URL, headers=headers, data=payload)
print(response.text)
{
"access_token": "eyJhbGciOiJS...",
"expires_in": 600,
"token_type": "Bearer",
"scope": "VerificationsAPI"
}{
"externalReferenceId": "UniqueRequestID-123456",
"options": {
"runAsync": false, // Synchronous processing
"mock": true // Mock mode for testing purposes
},
"checks": [
{
"checkTypeId": 1, // Address Verification
"externalCheckReferenceId": "AddressCheck-12345",
"maximumSources": 3, // Query up to 3 sources
"CheckMethod": 1, // Sequential processing
"matchesRequired": 1, // Minimum of 1 match required
},
{
"checkTypeId": 2, // Screening (PEP & Sanctions, Adverse Media)
"externalCheckReferenceId": "ScreeningCheck-67890",
"maximumSources": 3 // Query up to 3 sources
"CheckMethod": 1, // Sequential processing
},
{
"checkTypeId": 3, // UK Bank Account Check
"externalCheckReferenceId": "BankCheck-98765",
"maximumSources": 3, // Query up to 3 sources
"CheckMethod": 1, // Sequential processing
}
],
"profile": {
"titleId": 1, // Mr
"genderTypeId": 1, // Male
"firstName": "John",
"middleName": "Charles",
"lastName": "Doe",
"dateOfBirth": "1980-06-12",
"nationalityCountryCode": "GB", // United Kingdom
"placeOfBirthTownCity": "London",
"currentAddress": {
"structured": {
"flatApartmentSubBuilding": "10A",
"BuildingNumber": "50",
"BuildingName": "Example House",
"RoadStreet": "Example Street",
"townCity": "Exampleton",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2020-01-03T00:00:00"
}
},
"bankDetails": {
"accountNumber": "12345678",
"sortCode": "12-34-56"
}
}
}
"externalReferenceId": "ABCDEFGHI123456789""options": {
"runAsync": false,
"mock": true
}"checks": [
{
"checkTypeId": 1,
"externalCheckReferenceId": "Check-12345",
"maximumSources": 3,
"CheckMethod": 1,
"matchesRequired": 1
}
]"checks": [
{
"checkTypeId": 1, // Address Verification
"externalCheckReferenceId": "AddressCheck-12345",
"maximumSources": 3, // Default value is 3
"CheckMethod": 1, // Sequential check
"matchesRequired": 1, // Default value is 1
},
{
"checkTypeId": 2, // Screening
"externalCheckReferenceId": "ScreeningCheck-67890"
"maximumSources": 3, // Default value is 3
"CheckMethod": 1, // Sequential check
},
{
"checkTypeId": 3, // UK Bank Account Check
"externalCheckReferenceId": "BankCheck-98765"
"maximumSources": 3, // Default value is 3
"CheckMethod": 1, // Sequential check
}
]"profile": {
"titleId": 1, // Mr
"genderTypeId": 1, // Male
"firstName": "John",
"middleName": "Charles",
"lastName": "Smith",
"dateOfBirth": "1980-06-12",
"currentAddress": {
"structured": {
"flatApartmentSubBuilding": "10A",
"BuildingNumber": "50",
"BuildingName": "Example House",
"RoadStreet": "Example Street",
"townCity": "Exampleton",
"district": "Exampleshire",
"stateProvinceName": "Example",
"stateProvinceCode": "EG",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2020-01-03"
}
}
}
"currentAddress": {
"unstructured": {
"address1": "10A",
"address2": "50",
"address3": "Example House",
"address4": "Example Street",
"address5": "",
"townCity": "Exampleton",
"stateCounty": "Exampleshire",
"postZipCode": "EX12AB",
"countryCode": "GB",
"dateFrom": "2013-01-22",
"dateTo": "2020-06-11"
}
}"bankDetails": {
"accountNumber": "12345678",
"sortCode": "12-34-56",
"openedDate": "2015-03-10"
}Obtain an authentication token using client credentials.
client_credentials{{scope}}{{client_id}}{{client_secret}}Successful response
Unexpected error
{
"access_token": "text",
"token_type": "text",
"expires_in": 1
}POST /connect/token HTTP/1.1
Host: verifications-auth.tiller-verify.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 119
"grant_type='client_credentials'&scope='{{scope}}'&client_id='{{client_id}}'&client_secret='{{client_secret}}'"JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
Ok request
Verification Result DTO
ID of the correlation
External reference ID
Missing/invalid values
Verification result not found
Internal server error
JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
Subscriber Request Model
Request Url
Api Key
OK
Verification Result DTO
ID of the correlation
External reference ID
See Other
Bad Request
Request Timeout
Internal Server Error
JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
OK
Verification Result DTO
ID of the correlation
External reference ID
See Other
Bad Request
Request Timeout
Internal Server Error
JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
OK request
Verification Result DTO
ID of the correlation
External reference ID
Redirect
Missing/invalid values
Request Timeout
Internal server error
JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
Ok request
Verification Result DTO
ID of the correlation
External reference ID
Missing/invalid values
Verification result not found
Internal server error
JWT Authorization header using the Bearer scheme. Example: "Authorization: bearer {token}". You authenticate to the Tiller WealthXcel Verification API by providing your bearer token in the request header. Tiller WealthXcel Verification API requires the use of an access token used for requests made to the server side.
Ok request
Verification reference DTO
Value name of the reference
Category of the reference
Secondary code used for item identification. i.e. For country category items, of the ReferenceCode would be the ISO-3 country code
ID of the reference
Bad Request
Reference not found
Internal server error
Verification check request DTO
External reference ID
GET /api/v1/ongoingmonitoring/{correlationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2026-03-15T16:40:23.349Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}
]POST /api/v1/ongoingmonitoring/subscribe HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"returnUrl": "text",
"apiKey": "text"
}{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2026-03-15T16:40:23.349Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}POST /api/v1/ongoingmonitoring/unsubscribe HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2026-03-15T16:40:23.349Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2026-03-15T16:40:23.349Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}POST /api/v1/verifications HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2796
{
"options": {
"runAsync": true,
"mock": true,
"piiDataObscure": true
},
"externalReferenceId": "text",
"checks": [
{
"checkTypeId": 1,
"checkMethod": 1,
"matchesRequired": 1,
"maximumSources": 1,
"externalCheckReferenceId": "text",
"enableOngoingMonitoring": true,
"filters": {
"byDob": {
"includeAllDob": true,
"includeFullDob": true,
"includeYearOnlyDob": true,
"includeYearOnlyDobTolerance": 1,
"excludeIfSourceDobUnknown": true
},
"byName": {
"nameMatchType": 0,
"nameMatchMethod": 0,
"nameMatchMethodTolerance": 1
},
"byGender": {
"excludeGenderMatch": true,
"excludeIfSourceGenderUnknown": true
},
"byPepType": {
"excludePepTypes": [
"text"
],
"excludePepByFamilyAssociation": true
},
"byAdverseMediaType": {
"excludeAdverseMediaTypes": [
"text"
]
}
}
}
],
"profile": {
"titleId": 1,
"cardTypes": [
{
"cardTypeId": 1,
"cardNumber": "text"
}
],
"genderTypeId": 1,
"firstName": "text",
"middleName": "text",
"lastName": "text",
"maidenSecondLastName": "text",
"dateOfBirth": "2026-03-15T16:40:23.349Z",
"countryOfBirthCountryCode": "text",
"placeOfBirthTownCity": "text",
"nationalityCountryCode": "text",
"maritalStatusId": 1,
"mobileNumber": "text",
"landlineNumber": "text",
"email": "[email protected]",
"bankDetails": {
"accountNumber": "text",
"sortCode": "text",
"openedDate": "2026-03-15T16:40:23.349Z"
},
"currentAddress": {
"unStructured": {
"address1": "text",
"address2": "text",
"address3": "text",
"address4": "text",
"address5": "text",
"townCity": "text",
"stateCounty": "text",
"postZipCode": "text",
"countryCode": "text",
"dateFrom": "2026-03-15T16:40:23.349Z",
"dateTo": "2026-03-15T16:40:23.349Z"
},
"structured": {
"flatApartmentSubBuilding": "text",
"buildingNumber": "text",
"buildingName": "text",
"roadStreet": "text",
"district": "text",
"townCity": "text",
"stateProvinceName": "text",
"stateProvinceCode": "text",
"postZipCode": "text",
"countryCode": "text",
"dateFrom": "2026-03-15T16:40:23.349Z",
"dateTo": "2026-03-15T16:40:23.349Z"
}
},
"previousAddresses": [
{
"unStructured": {
"address1": "text",
"address2": "text",
"address3": "text",
"address4": "text",
"address5": "text",
"townCity": "text",
"stateCounty": "text",
"postZipCode": "text",
"countryCode": "text",
"dateFrom": "2026-03-15T16:40:23.349Z",
"dateTo": "2026-03-15T16:40:23.349Z"
},
"structured": {
"flatApartmentSubBuilding": "text",
"buildingNumber": "text",
"buildingName": "text",
"roadStreet": "text",
"district": "text",
"townCity": "text",
"stateProvinceName": "text",
"stateProvinceCode": "text",
"postZipCode": "text",
"countryCode": "text",
"dateFrom": "2026-03-15T16:40:23.349Z",
"dateTo": "2026-03-15T16:40:23.349Z"
}
}
]
},
"companyDetails": {
"countryCode": "text",
"state": "text",
"companyName": "text",
"companyNumber": "text",
"companyAddress": "text",
"branch": "text"
},
"officerDetails": {
"countryCode": "text",
"state": "text",
"companyName": "text",
"companyNumber": "text",
"companyAddress": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"officerId": "text",
"position": "text"
},
"clientEmail": "text",
"clientId": "text"
}GET /api/v1/verifications/{correlationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"correlationId": "123e4567-e89b-12d3-a456-426614174000",
"externalReferenceId": "text",
"checkStatuses": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"checkTypeId": 1,
"externalCheckReferenceId": "text",
"status": {
"id": 1,
"status": "text"
},
"resultCount": {
"totalSourcesChecked": 1,
"totalSourcesPassed": 1,
"totalSourcesFailed": 1,
"totalSourcesForReview": 1
},
"matchesRequired": 1,
"sourceResults": {
"id": 1,
"date": "2026-03-15T16:40:23.349Z",
"rule": "text",
"ruleId": 1,
"status": {
"id": 1,
"status": "text"
},
"result": {
"id": 1,
"result": "text"
},
"title": "text",
"summaryTitle": "text",
"summary": [
{
"id": 1,
"key": "text",
"value": "text"
}
],
"results": [
{
"id": 1,
"title": "text",
"description": "text",
"result": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
}
}
]
}
}
],
"resultsExcludedByFilters": [
{
"id": 1,
"title": "text",
"description": "text",
"recordedDate": "text",
"detail": {
"reasons": [
{
"id": 1,
"key": "text",
"result": "text",
"reason": "text",
"code": "text",
"metaData": {
"sourceName": "text",
"sourceOriginName": "text",
"title": "text",
"date": "text",
"name": "text",
"dob": [
"text"
],
"matchScore": 1,
"riskScore": 1,
"gender": "text",
"relations": [
{
"relationType": "text",
"entityName": "text"
}
],
"positions": [
{
"position": "text",
"fromYear": "text",
"toYear": "text"
}
],
"aliases": [
{
"type": "text",
"name": "text"
}
],
"regNumber": "text",
"branch": "text",
"address": "text",
"currentStatus": "text",
"incorporationDate": "text",
"dissolutionDate": "text",
"type": "text",
"officers": [
{
"id": 1,
"name": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"status": "text",
"address": "text"
}
],
"parentCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"primaryCompanyInfo": {
"companyName": "text",
"countryCode": "text",
"regNumber": "text"
},
"filings": {
"lastFilingDate": "text",
"filingType": {
"filingTypeCode": "text",
"filingTypeDescription": "text"
}
},
"officerId": "text",
"position": "text",
"startDate": "text",
"endDate": "text",
"actedCompany": "text",
"actedRegNumber": "text",
"country": "text",
"state": "text"
},
"excludedReasons": [
"text"
]
}
]
}
}
]
},
"result": {
"id": 1,
"result": "text"
}
}
],
"overallResult": {
"id": 1,
"result": "text"
},
"overallStatus": {
"id": 1,
"status": "text"
}
}
]GET /api/v1/verifications/references HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"referenceName": "text",
"referenceCategory": "text",
"referenceCode": "text",
"referenceId": 1
}
]