Through this endpoint it’s possible to consult a list of NSNRecs linked to an NF-e using its access key.
URL
Production: POST https://nfe.ns.eti.br/util/list/nsnrecs
Input data
The input data of this method must be in the request body in JSON format or as a QueryString in the method URL.
| Field | Description | Data Type | Occurrence | Notes |
|---|---|---|---|---|
| X-AUTH-TOKEN | User access token | String | 1-1 | |
| chNFe | NFe- access key | Int | 1-1 |
Request example
NSNRecs List Request
curl -X POST \
-H "Content-Type: application/json" \-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "chNFe":"43170120121850000156550010002037451076558734"}'\
https://nfe.ns.eti.br/util/list/nsnrecs
Returned data
| Field | Description | Data Type | Occurrence | Parent | Notes |
|---|---|---|---|---|---|
| status | Processing status code | Int | 1-1 | ||
| motivo | Processing status literal description | String | 1-1 | ||
| nsNRecs | Object containing the requested person's data | Array | 1-1 | It will only contain items if nsNRecs linked to the provided NF-e key are found | |
| nsNRec | Linked nsNRec | Int | 1-1 | nsNRecs | |
| cStat | nsNRec status code | Int | 1-1 | nsNRecs | |
| xMotivo | nsNRec status literal descript | String | 1-1 | nsNRecs |
Return example
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"nsNRecs": [
{
"nsNRec": 210584,
"cStat": 100,
"xMotivo": "Autorizado o uso da NF-e"
}
]
}
Return codes
| Code | Description |
|---|---|
| 200 | Consult carried out successfully |
| -2 | Invalid access key |