💸Transaction Screening API This resource allows you to retrieve the valid identification document types accepted by Rillis, categorized by country and entity type. This is essential for correctly registering Remitters and Beneficiaries in the transaction screening process: By using this endpoint, you can obtain the "type" corresponding to the specific country, which will allow you to identify the required document type. URL: https://app.rillis.io/api/v1/resources/validation/document-typesRequest# Request Parameters (Query Strings)# All parameters, including authentication, must be sent as query strings in the URL. Parameter Type Required Description client_idString Yes Your unique client identifier. client_secretString Yes Your secret API key. countryString No ISO3 country code (e.g., COL, USA, ARG). Case-insensitive. entityEnum No Filter by entity type: person or company. Case-insensitive.
Response Scenarios# The API response adapts dynamically based on the filters applied. 1. Full List (No filters)# Returns all supported documents for both individuals and legal entities across all countries. {
"person" : [
{
"code" : "COL" ,
"name" : "COLOMBIA" ,
"locTypes" : [
{ "type" : "CO-CC" , "name" : "CEDULA DE CIUDADANIA" } ,
{ "type" : "CO-PASS" , "name" : "PASSPORT NUMBER" }
]
}
] ,
"company" : [
{
"code" : "COL" ,
"name" : "COLOMBIA" ,
"locTypes" : [
{ "type" : "CO-NIT" , "name" : "TAX IDENTIFICATION NUMBER" }
]
}
]
} 2. Filtered by Entity and Country# Request: GET .../document-types?country=COL&entity=person# {
"person" : [
{
"code" : "COL" ,
"name" : "COLOMBIA" ,
"locTypes" : [
{ "type" : "CO-CC" , "name" : "CEDULA DE CIUDADANIA" } ,
{ "type" : "CO-PASS" , "name" : "PASSPORT NUMBER" }
]
}
]
} Response Parameters# Parameter Type Description person Array List of countries with document types for individuals. company Array List of countries with document types for companies. code String Country code in ISO 3166-1 alpha-3 format. name String Country name. locTypes Array List of document types available for the country. locTypes.type String Document type code. locTypes.name String Document type name.
Error Responses# In case of an error, the API will return an appropriate HTTP status code along with a JSON response containing error details: Status Code Description 400 Bad Request - The request was invalid or cannot be processed. 401 Unauthorized - Authentication credentials are missing or invalid. 403 Forbidden - The client does not have permission to access the requested resource. 429 Too Many Requests - The client has sent too many requests in a given amount of time. 500 Internal Server Error - An error occurred on the server.
Example Error Response# {
"success" : false ,
"error" : "Invalid country code" ,
"error_code" : "INVALID_PARAMETER" ,
"details" : "Country code must be a valid ISO 3166-1 alpha-2 code"
} Rate Limits# Maximum of 100 requests per minute.
Maximum of 1,000 requests per hour.
Maximum of 10,000 requests per day.
Exceeding these limits will result in a 429 Too Many Requests response. Modified at 2026-02-06 21:07:00
