get https://sandbox.link.kiban.com/api/v1/curp/?itemsPerPage=&page=
Intro
With this API you can retrieve all the executions made to the different CURP services
Important Points
Services
In order to retrieve the specific information of a service, you must indicate as a path paramater which service you want to retrieve.
Here are the possible values for the path parameter "service"
- validate, to retrieve the items consulted in Validate by CURP
- validateData, to retrieve the items consulted in Validate by data
Pagination Parameters
The next two pagination parameters are mandatory to do the request.
- itemsPerPage, number of items by page, should be an integer between [1, 1000]
- page, number of recovered page, should be an integer greater than 0
The next errors can be returned if there is a problem with the request body or the execution of this service:
"itemsPerPage": ERROR_QUERY_PARAM_FORMAT; indicates that should be an integer value between 1 and 1000
"page": ERROR_QUERY_PARAM_FORMAT; indicates that should be an integer value greater than 0
Response
For all the CURP services, kiban will return a list of items with the next structure:
{
"currentPage": 1,
"hasNextPage": true,
"items": [
{
"id": "64067ad3299f4274e3f9cbfc",
"createdAt": "2023-03-06T23:44:19.728Z",
"finishedAt": "2023-03-06T23:44:46.077Z",
"duration": 26348898411,
"status": "SUCCESS"
}
]
}
Where:
- currentPage, is the index of the retrieved page
- hasNextPage, indicate if there are more pages
- items, list of items requested
- id, identifier of the request.
- createdAt, date time of the initial call
- finishedAt, the date time of the response of the initial call
- duration, how long it took to get the response.
- status, status of the request