Skip to main content

Response Model

API responses are flat JSON objects with common fields plus route-specific fields.

Common fields:

  • status: success or error
  • code: integer (0 for success)
  • message: optional string (mainly for errors)

Error shape:

{
"status": "error",
"code": 3,
"message": "Missing required parameter"
}

Success shape example:

{
"status": "success",
"code": 0,
"documentID": 12345,
"fiscalID": "..."
}