/verify/id_check

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to verify Colombia ID Number.

Request Method

POST

Request URL

https://cloudapi.colombia.accuauth.com/verify/id_check

Debugging Tool

Debugging Tool

2.Request Params

2.1 Request Header

Parameter Type Required Description
X-DF-API-ID string Yes For API credentials，Please visit API Request
X-DF-API-SECRET string Yes For API credentials，Please visit API Request

2.2 Request Body

Required Fields Type Description
required id_number string ID number
required issue_date string Issue date, format as: DD/MM/YYYY.

3.Response Params

Fields Type Description
request_id string Unique id of each request
status string Response status, OK for success request, Error Codes for failed request
result_code string Result code
result_message string Result message
result object The verification result

3.1 Result Codes

Value Description Billable
0 Success Yes
1 ID number is invalid or the issued date does not correspond to the ID Yes

3.2 Elements in `result`

Fields Type Description
estatus string OK or ERROR
codigoValidacion string Validation code
aNombreDe string Name
cedulaCiudadania string Comma seperated ID number
fechaExpedicion string Issue date
lugarExpedicion string Issue address
estado string valid status
claveMensaje string Same as result_code
documento string Base64 encoded pdf document
Response Syntax
{
    "status": "OK",
    "result_code": "0",
    "result_message": "success",
    "result": {
        "estatus": "OK",
        "codigoValidacion": "ec167xxx7947.7xxxxx",
        "claveMensaje": 0,
        "cedulaCiudadania": "1.028.029.xxx",
        "fechaExpedicion": "17 DE FEBRERO DE 2015",
        "lugarExpedicion": "APARTADO - ANTIOQUIA",
        "aNombreDe": "ANYELA ESTEFANIA XXXXX XXXXXX",
        "estado": "VIGENTE",
        "documento": "Base64 encoded pdf doc"
    },
    "request_id": "TID0a1e67ac2ca24e349e2023757d5add5a"
}

4.Error Codes

Common error codes of this API:

Http Status Code Status Field Description
400 INVALID_ARGUMENT Request parameter is invalid
400 VERIFY_FAILED Verify failed
400 ABNORMAL_BEHAVIOURS_DETECTED Request with same parameters repeated more than amount of times
401 UNAUTHORIZED Unauthorized or access is denied
401 KEY_EXPIRED Your API ID has expired
403 NO_PERMISSION You are not authorized to use this API
403 OUT_OF_QUOTA API calls quota exceeded
403 RATE_LIMIT_EXCEEDED API request frequency exceeds the limit
404 NOT_FOUND Requested API cannot be found
500 INTERNAL_ERROR Internal server error
512 SOURCE_SERVICE_UNAVAILABLE Source service is unavailable
513 SOURCE_SERVICE_TIMEOUT Source service is timeout

Comment: Please see the reason field for details when the above 40X / 51X error occurred

Response Syntax
{
  "status": "INVALID_ARGUMENT",
  "reason": "argument 'id_number': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

    No results matching ""