Skip to main content

ID Status

Description​

Consultation that returns the status of an identity document (cédula) issued by the Registraduria.

HTTP method GET​

Endpoint​

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/co-identity/{cedula}/check-id-status
info

Before proceeding, make sure you have your jwt token, if you don't have it, check the login documentation.

Request header parameter​

NAMEREQUIREDTYPEDESCRIPTION
Authorization✅stringbearer jwt token

URI request parameter​

NAMEREQUIREDTYPEDESCRIPTION
cedula✅stringColombia identity document.

Status code responses​

CodeDescription
200 OK
400 Bad request
401 Unauthorized
404 Not found
500 Internal server error.

The full documentation error codes can be found here.

Response 200 status code​

{
    "traceId": "b2345cfc7bee621e",
    "timestamp": "2023-05-15 11:59:35",
    "data": {
        "segundoNombre": "ANDRES",
        "fechaExp": "1992-03-31T00:00:00",
        "primerNombre": "GUSTAVO",
        "primerApellido": "SALAZAR",
        "estadoDoc": "0",
        "segundoApellido": "VALENCIA",
        "departamentoExpedicion": "VALLE",
        "particula": " ",
        "localizacion": "CALI",
        "vivo": true,
        "nuip": "94403443",
        "respuestaTransaccion": {
            "errorEntransaccion": [],
            "esExitosa": true
        },
        "numeroResolucion": ""
    },
    "codeName": "OK"
}

Response 400 status code​

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "-",
    "data": null
}

Response 401 status code​

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/idv-govcheck/v1/co-identity/{cedula}/check-id-status"
}

Response 404 status code​

{
    "traceId": "ef2407b8c0df635c",
    "timestamp": "2023-05-22 17:25:55",
    "code": "IDV-1002",
    "message": "Data not found."
}

Response 500 status code​

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}