API Responses

All responses will have a common structure and specific parameters. The format is as follows:

Body

• type (enum[string]): Type of response:
  • success
  • warning
  • error
• code (string): Identifier code of the result. It is a guiding code and is not strictly linked to the reason for the response, meaning that the code does not unequivocally identify the response. For more details, visit the following link: Response Codes.
  • Code = 0 --> success
  • Code > 0 --> warning
  • Code < 0 --> error
• detail (string): Alphanumeric code separated by underscores and without uppercase letters that unequivocally identifies the response. Useful for managing the different use cases of an operation.
• description (string): Literal description of the response message.
• uuid (string): Unique identifier of the request, essential for traceability.
• request_id (string): Necessary for completing some operations. Those requiring it will be indicated.
• payload (object): Response parameters.

Headers

• Content-Signature: The signature of the response body with the secret key. HMAC(body, secret, mode).

Example

{
    "type": "success",
    "code": "0",
    "detail": "action_successful",
    "description": "Action successful",
    "uuid": "40f71c58-499d-404f-a3fe-6aa880a64176",
    "payload": {
        "param1": "value1",
        "param2": "value2"
    }
}