All URIs are relative to https://api.trulioo.com
| Method | HTTP request | Description |
|---|---|---|
| documentDownload | GET /verifications/v1/documentdownload/{transactionRecordId}/{fieldName} | Download Document |
| getTransactionRecord | GET /verifications/v1/transactionrecord/{id} | This method is used to retrieve the request and results of a verification performed using the verify method. The response for this method includes the same information as verify method's response, along with data present in the input fields of the verify request. |
| getTransactionRecordAddress | GET /verifications/v1/transactionrecord/{id}/withaddress | Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing. |
| getTransactionRecordVerbose | GET /verifications/v1/transactionrecord/{id}/verbose | Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing and watchlist details. |
| getTransactionStatus | GET /verifications/v1/transaction/{id}/status | This method is used to retrieve the processing status of an asynchronous transaction. The response for this method includes the processing status of the verification, the TransactionID, the TransactionRecordID as well as whether the verification request has timed out. |
| verify | POST /verifications/v1/verify | Calling this method will perform a verification. If your account includes address cleansing set the CleansedAddress flag to get additional address information in the result. You can query configuration to get what fields are available to you in each each country. It is also possible to get sample requests from the customer portal. |
Object documentDownload(transactionRecordId, fieldName)
Download Document
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
String transactionRecordId = "transactionRecordId_example"; // String | id of the transactionrecord, this will be a GUID
String fieldName = "fieldName_example"; // String | document field name
try {
Object result = apiInstance.documentDownload(transactionRecordId, fieldName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#documentDownload");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| transactionRecordId | String | id of the transactionrecord, this will be a GUID | |
| fieldName | String | document field name |
Object
- Content-Type: Not defined
- Accept: application/json, text/json
TransactionRecordResult getTransactionRecord(id)
This method is used to retrieve the request and results of a verification performed using the verify method. The response for this method includes the same information as verify method's response, along with data present in the input fields of the verify request.
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
String id = "id_example"; // String | id of the transactionrecord, this will be a GUID
try {
TransactionRecordResult result = apiInstance.getTransactionRecord(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#getTransactionRecord");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | id of the transactionrecord, this will be a GUID |
- Content-Type: Not defined
- Accept: application/json, text/json
TransactionRecordResult getTransactionRecordAddress(id)
Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing.
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
String id = "id_example"; // String | id of the transactionrecord, this will be a GUID
try {
TransactionRecordResult result = apiInstance.getTransactionRecordAddress(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#getTransactionRecordAddress");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | id of the transactionrecord, this will be a GUID |
- Content-Type: Not defined
- Accept: application/json, text/json
TransactionRecordResult getTransactionRecordVerbose(id)
Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing and watchlist details.
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
String id = "id_example"; // String | id of the transactionrecord, this will be a GUID
try {
TransactionRecordResult result = apiInstance.getTransactionRecordVerbose(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#getTransactionRecordVerbose");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | id of the transactionrecord, this will be a GUID |
- Content-Type: Not defined
- Accept: application/json, text/json
TransactionStatus getTransactionStatus(id)
This method is used to retrieve the processing status of an asynchronous transaction. The response for this method includes the processing status of the verification, the TransactionID, the TransactionRecordID as well as whether the verification request has timed out.
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
String id = "id_example"; // String | id of the asynchronous transaction, this will be a GUID
try {
TransactionStatus result = apiInstance.getTransactionStatus(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#getTransactionStatus");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | id of the asynchronous transaction, this will be a GUID |
- Content-Type: Not defined
- Accept: application/json, text/json
VerifyResult verify(request)
Calling this method will perform a verification. If your account includes address cleansing set the CleansedAddress flag to get additional address information in the result. You can query configuration to get what fields are available to you in each each country. It is also possible to get sample requests from the customer portal.
// Import classes:
//import com.trulioo.normalizedapi.ApiClient;
//import com.trulioo.normalizedapi.ApiException;
//import com.trulioo.normalizedapi.Configuration;
//import com.trulioo.normalizedapi.auth.*;
//import com.trulioo.normalizedapi.api.VerificationsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");
VerificationsApi apiInstance = new VerificationsApi();
VerifyRequest request = new VerifyRequest(); // VerifyRequest |
try {
VerifyResult result = apiInstance.verify(request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling VerificationsApi#verify");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| request | VerifyRequest |
- Content-Type: application/json, text/json
- Accept: application/json, text/json