Intro
This API allows you to obtain your clients' compliance opinion, it connects to the SAT to obtain the most current data.
Important points
Request parameters
Service input parameters int he body
| Field | Type | required | length | Description |
|---|---|---|---|---|
| rfc | String | true | 12- 13 | Provide a valid RFC. It can be an RFC of a PM with a length of 12 characters or an RFC of a PF with a length of 13 characters |
| password | String | true | 8 | Indicate the CIEC password. |
Callback
This service is asynchronous
This service is asynchronous, so you will not receive the data immediately, only a response indicating that we received your request successfully.
If you want to receive the final response you should pool the get by id endpoint or define a callback
In order to receive callback data in your API you must define the following in the request headers::
| header name | Description |
|---|---|
| urlCallback | Header to indicate the URL to which we will send the notifications with the response |
| xApiKeyCallback | Header to assign an API key if you need to add security to your service |
Successful response
This service is asynchronous, so you will not receive the data immediately, only a response indicating that we received your request successfully.
The response you will receive will be like this:
{
"id": "67c213e50e3d5ed478259813",
"createdAt": "2025-02-28T19:52:05.509619314Z",
"finishedAt": "0001-01-01T00:00:00Z",
"duration": 127,
"status": "PENDING",
"request": {
"rfc": "ABC080220554",
"password": "P4ssw0rd"
}
}
As we indicated in the Callbacks section, in order to successfully retrieve the response, you must pool the get by id API or have defined callbacks.
In either case, you will receive the recovered data. To see these response examples, we suggest you review the http 200 examples in the examples section.
Response fields
Below we describe the fields you may receive in your response.
| Field | subfield | Type | Description |
|---|---|---|---|
| folio | String | Requested folio registered in the SAT | |
| rfc | String | Requested RFC | |
| nombre | String | Name of the person or institution requested | |
| respuesta | String | Indicates the response of the compliance opinion | |
| resultado | String | Indicates the result of the compliance opinion, the possible values are: - positivo - negativo | |
| obligaciones | Array | Array of obligations registered in the SAT | |
| obligacion | String | Indicates the name of the reported obligation | |
| periodos | String | Indicates the reporting period for the obligation, which can come in two forms. - By year, "Anual / year" is reported, where "Anual" indicates that this obligation covers the entire year and "year" indicates the year reported, e.g. "Anual / 2022" - By month, "month / year" is reported, where "month" indicates that this obligation covers the month provided and "year" indicates the year reported, e.g. "Enero / 2022" | |
| creditosFiscales | Array | Array containing a list of strings with the tax credits found |
Test the service (test cases)
We have included a query parameter in Sandbox to enable you to query the test cases that we created for running tests. To get a response, fill the testCaseId parameter with any of the following cases:
| Num | Id | Name | Description |
|---|---|---|---|
| 1 | 67aba5e0e7b5712f0fd80a3d | Credenciales inválidas | Example for incorrect credentials |
| 2 | 67a39444cc2dd1fc611a440d | Negativo | Indicates a negative compliance opinion |
| 3 | 67a523d0a655591273f00ba1 | Positivo | Indicates a positive compliance opinion |
| 4 | 67a523d92860d91fe5bedb47 | Sin obligaciones fiscales | Indicates an opinion of compliance without tax obligations |
Test your own test case
In case you want to test your own test case created in link, you can send in the testCaseId parameter the identifier of the test case you want to use.
For more information visit our knowledge center to know more about test cases