Documentação API
Status API
1xx: status referente a autenticação
| Cod | Motivo |
|---|---|
| 101 | hash de segurança não enviada |
| 102 | registro para uso da api não está válido |
| 103 | hash de segurança inválida |
| 104 | request inválida |
| 105 | serviço da empresa para integração não está válido e ativo |
| 106 | quantidade de solicitações de documentos atingido |
2xx: status de sucesso
| Cod | Motivo |
|---|---|
| 200 | status ok, requisição deu certo |
| 204 | status ok, nenhum registro encontrado |
301 até 319: erro referente às partes:
| Cod | Motivo |
|---|---|
| 301 | Campos inválidos para cadastrar a parte |
| 302 | Cpf já cadastrado |
| 303 | Email já cadastrado |
| 304 | nenhum campo alterado |
| 311 | parte com status inválido |
| 312 | parte com status válido |
| 313 | produto de identificacao 'outros' não habilitado. |
| 314 | parâmetros inválidos para cadastrar parte com documento de identificação 'outros'. |
| 315 | slot já preenchido. |
32x: status referente às validações da parte:
| Cod | Motivo |
|---|---|
| 320 | Validação pendente |
4xx: status referente ao documento:
| Cod | Motivo |
|---|---|
| 399 | arquivo enviado não é aceito |
| 400 | arquivo enviado com sucesso |
| 401 | arquivo não enviado |
| 402 | arquivo enviado não encodado em base64 |
| 403 | arquivo corrompido |
| 404 | nenhum registro encontrado |
| 405 | erro ao gerar o arquivo para download |
| 407 | o arquivo já está assinado |
| 408 | erro ao gerar token de assinatura |
| 409 | token de assinatura inválido |
| 410 | documento não pode ser invalidado |
| 411 | não foi possível gerar um identificador para upload |
| 412 | identificador para upload inválido ou não está mais disponível |
| 413 | parte não pode assinar automaticamente |
| 420 | arquivo assinado com sucesso |
| 421 | token de assinatura gerado com sucesso |
| 450 | modelo não encontrado |
50x: status referente as chaves:
| Cod | Motivo |
|---|---|
| 501 | chaves geradas com sucesso |
| 501 | nenhuma chave gerada válida para assinar |
6xx: status referente os links de acesso:
| Cod | Motivo |
|---|---|
| 600 | link não encontrado ou inexistente |
| 601 | nenhum documento pendente para poder gerar link |