Intro
This API is meant to generate an RFC with homoclave for Personas Físicas. Kiban cloud use the algorithm provided by the SAT to generate the exact RFC.
In the answer the complete RFC with the homoclave will be included.
Important Points
Mandatory Fields
All the fields in the body are mandatory and kiban cloud performs validations on the information sent to detect special characters or incorrect formats.
field | type | required | length | Description |
---|---|---|---|---|
nombres | Alphabetic | Yes | N/A | Person's names. |
apellidoPaterno | Alphabetic | Yes | N/A | Person's last name. |
apellidoMaterno | Alphabetic | Yes | N/A | Person's second last name. |
fechaNacimiento | Date | Yes | 10 | Birthdate with format yyyy-mm-dd |
Test the service (test cases)
You will not be able to test the operation of this service in the sandbox environment, because we always return a single calculated value, to validate the operation, we suggest you make a query in the production environment
Successful response
Inside the response object you will only get the next field.
subfield | Description |
---|---|
rfc | Will contain the generated RFC. |
{
"id": "656004202bacd50889a5840d",
"createdAt": "2023-11-24T02:02:08.170943657Z",
"finishedAt": "2023-11-24T02:02:08.171039692Z",
"duration": 0,
"status": "SUCCESS",
"request": {
"apellidoMaterno": "romero",
"apellidoPaterno": "lopez",
"fechaNacimiento": "1989-11-27",
"nombres": "edgar"
},
"response": {
"rfc": "GOGR911205JG7"
}
}
Listing the possible not success responses
Required fields
You will get a 400 bad request error when any of the required fields are not provided.
{
"apellidoMaterno": "EMPTY_ERROR; can't be empty; must have at least lastName or maidenName",
"apellidoPaterno": "EMPTY_ERROR; can't be empty; must have at least lastName or maidenName",
"fechaNacimiento": "FORMAT_ERROR; expected format: yyyy-mm-dd",
"nombres": "EMPTY_ERROR; can't be empty"
}
Invalid Format
Some of the fields contain illegal characters or formatting, the service will return the a 400 bad request
{
"apellidoMaterno": "CONTAINS SPECIAL CHARS",
"apellidoPaterno": "CONTAINS SPECIAL CHARS",
"fechaNacimiento": "FORMAT_ERROR; expected format: yyyy-mm-dd",
"nombres": "CONTAINS SPECIAL CHARS"
}
Unauthorized
It means that the provided API is incorrect and that you are not authorized to access it. You will not receive a body, only a 401 HTTP code.