Pular para o conteúdo principal

Get Process

Esse artigo explica como obter o resultado um processo de captura ou reaproveitamento de documentos através da REST API do Unico IDDocs.

Como usar?​

Faça uma requisição GET para o endpoint /processes/v1/{id}​

Com o token de acesso válido (e API KEY devidamente configurada para IDDocs), faça uma requisição para o endpoint (GET/processes/v1/{id}). O parâmetro {id} deve ser o mesmo que foi gerado durante a criação da transação na requisição CreateProcess.

Parametros:

  • HEADER PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
APIKEYStringMandatórioAPI key
AuthorizationStringMandatórioToken de acesso
  • PATH PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
processoIdStringMandatórioNúmero do processo

Requisição com Sucesso​

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes parâmetros:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": 3,
  },
  "document": {
    "id": "b97c3fd9-d95d-413f-bc0a-75eb87304421",
    "type": "CNH",
    "cpfMatch": false,
    "content": {
      "numero": "044589731564",
      "rgNumero": "123456789 SESP PR",
      "nomeCivil": "Homer Simpson",
      "filiacao": [
        "Monasimpson",
        "Monasimpson"
      ],
      "dataNascimento": "1990-05-12T00:00:00Z",
      "dataHabilitacao": "1997-11-18T00:00:00Z",
      "dataExpiracao": "2017-12-07T00:00:00Z",
      "dataEmissao": "2012-12-07T00:00:00Z",
      "localEmissao": "Curitiba PR",
      "categoria": "B",
      "renachNumero": "PR904987581"
    },
    "fileUrls": [
            "https://url-signer-1",
            "https://url-signer-2"
        ]
  }
}

Os parâmetros de retorno são:​

NomeTipoDescrição
idstringIndica o ID do processo criado com o envio da foto.
statusintegerIndica o status do Processo, usado para indicar se está concluído ou não. O enumerado completo pode ser visto em Status do Processo.
document.idstringIndica o ID do documento criado.
document.typestringIndica o tipo do documento retornado pela tipificação. O enumerado completo pode ser visto em Tipos de Documentos.
document.cpfMatchstringRetorna se o CPF informado é igual ao contido no documento.
Caso o CPF enviado seja inválido (exemplo: 123.456.789.12) esse campo é devolvido como falso automaticamente antes da comparação.
document.contentlistLista de informações contidas no documento. Ela será devolvida sempre que a qualidade do documento permitir a extração de dados.
O conteúdo retornado no document.content vai variar de acordo com o parâmetro document.type. **Mais detalhes na próxima tabela.
document.fileUrlsintUrls assinadas dos arquivos que compõem o documento. Para ter acesso às imagens do documento é só acessar essas urls que tem um tempo de expiração de 10 minutos.
Dica: Polling
  • Esse método pode ser utilizado a cada 2 segundos para verificar o status do processo. Para mais informações sobre todos os status possíveis, consulte Status do Processo.

Conteúdo retornado no document.content baseado no document.type​

O conteúdo retornado é compatível com descritivo abaixo:

  • Type: CNH
  • Content: Carteira Nacional de Habilitação
    • String numero;
    • String rgNumero;
    • String cpfNumero;
    • String nomeCivil;
    • List string filiacao;
    • Datetime dataNascimento;
    • Datetime data_habilitacao;
    • Datetime data_expiracao;
    • Datetime data_emissao;
    • String local_emissao;
    • String categoria;
    • String renachNumero;
"content": {
    "numero": "044589731564",
    "rgNumero": "123456789 SESP PR",
    "nomeCivil": "Homer Simpson",
    "filiacao": [
        "Monasimpson",
        "Monasimpson"
    ],
    "dataNascimento": "1990-05-12T00:00:00Z",
    "dataHabilitacao": "1997-11-18T00:00:00Z",
    "dataExpiracao": "2017-12-07T00:00:00Z",
    "dataEmissao": "2012-12-07T00:00:00Z",
    "localEmissao": "Curitiba PR",
    "categoria": "B",
    "renachNumero": "PR904987581"
}

Importante
  • Quando a requisição GET for para um processo com status 5 (erro), o status code de retorno é 410 (Gone) ao invés de 200 (Success).

Erro na Requisição​

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.