Document Types

This endpoint allows you to access valid document types by country. There are two types of documents:

Natural persons: person

Legal entities: company

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-types

Method: POST

Request

Body Parameters

Parameter	Type	Required	Description
client_id	String	Yes	Your unique client identifier.
client_secret	String	Yes	Your secret key for API authentication.

Example Request (All Document Types)

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}

Response

A successful request [status: 200] will return the following JSON response:

{
    "person": [
        {
            "code": "CHL",
            "name": "CHILE",
            "locTypes": [
                {
                    "type": "CL-PASS",
                    "name": "PASSPORT NUMBER"
                },
                // Additional document types...
            ]
        },
        // Additional countries...
    ],
    "company": [
        {
            "code": "CHL",
            "name": "CHILE",
            "locTypes": [
                {
                    "type": "CL-RUN",
                    "name": "ROL UNICO NACIONAL"
                },
                // Additional document types...
            ]
        },
        // Additional countries...
    ]
}

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.

Document Types

Request#

Body Parameters#

Example Request (All Document Types)#

Response#

Response Parameters#

Error Responses#

Example Error Response#

Rate Limits#