Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Tax compliance status

Retrieve tax compliance statuses for a link

Retrieve the Tax compliance status information for a specific fiscal link.

post/api/tax-compliance-status/

Query parameters

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

Request body

linkstring uuid required

The link.id you want to retrieve information for.

attach_pdfboolean

When set to true, you will receive the PDF in binary format in the response.

save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Example request

{
  "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
  "attach_pdf": true,
  "save_data": true
}

Response

Ok (when save_data=false)

idstring uuid

Belvo's unique identifier for the current item.

collected_atstring date-time required

The ISO-8601 timestamp when the data point was collected.

created_atstring date-time

The ISO-8601 timestamp of when the data point was created in Belvo's database.

internal_identificationstring nullable

The institution’s internal identification number for the document.

pdfstring binary nullable required

Tax compliance status PDF as a binary.

rfcstring nullable

The account holder's RFC (Registro Federal de Contribuyentes) number.

outcome'POSITIVE' | 'NEGATIVE' | 'NO_OBLIGATIONS' nullable

Indicates whether the taxpayer is complying to all their tax obligations (POSITIVE), if they are not (NEGATIVE), or have none to comply to (NO_OBLIGATIONS).

Example response

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "internal_identification": "20NE1234567",
  "pdf": "=PDF-STRING=",
  "rfc": "KDFC211118IS0",
  "outcome": "NEGATIVE"
}