ID status
Description​
Verify a user's national ID against the Uruguay DGREC database. MSLA ID´s check connects to the Dirección General del Registro de Estado Civil / DGREC site for National Id validation. This website provides information on birth certificates whether a national id number is provided (national id, passport, or foreign identification), and it returns the public birth certificate information associated with the id number.
HTTP method POST​
Endpoint​
https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/ur-identity/{cedula}/check-id-status
info
Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.
Request header parameter​
NAME | REQUIRED | TYPE | DESCRIPTION |
---|---|---|---|
Authorization | ✅ | string | bearer jwt token |
URI request parameter​
NAME | REQUIRED | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|---|
cedula | ✅ | string | Uruguay ID official number | - |
Status code responses​
Code | Description |
---|---|
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": {
"First_name": "string",
"Last_name": "string",
"Date_of_birth": "string",
"District": "string",
"Certificate_number": "string"
}
}
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/ur-identity/{cedula}/check-id-status"
}
Response 500 status code​
{
"traceId": "43a20f33d4e8730d",
"timestamp": "yyyy-mm-dd HH:MM:SS",
"code": "IDV-1001",
"message": "A generic error has occurred.",
"data": null
}