Retornos possíveis da requisição
| Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
| 201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
| 409 | Conflito | Ocorre quando é enviado uma consulta repetida dentro de 15 minutos. | O requestId que foi criado com os mesmo dados da solicitação para que possa ser consultado a resposta. |
| 422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
| 503 | Service Unavailable | Consulta está temporariamente indisponível | Nada |
Exemplos de retornos
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
Significa que ocorreu um erro de validação dos dados enviados.
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo nome é obrigatório."
]
}
}Status 503
O status 503 significa que a consulta está indisponível no momento.