Create Process

Este artigo explica como criar um processo de captura ou reaproveitamento de documentos através da REST API do Unico IDDocs.

Para a criação do processo de validação de documentos é possível utilizar:

• Documentos reaproveitados (veja mais em docs/IDDocs/Integracao/GuiaAPI/GetReusableDocuments.md);
• Documentos capturados com auxílio de ferramentas de digitalização (câmera, scanner).

Como usar?

Faça uma requisição POST para o endpoint /processes/v1

Com o token de acesso válido (e API KEY devidamente configurada para IDDocs), faça uma requisição para o endpoint (POST/processes/v1) enviando os seguintes parâmetros:

{
  "subject": {
    "Code": "CPF_Titular",
    "Name": "NOME_Titular",
    "Email": "EMAIL_Titular",
    "Phone": "PHONE_Titular"
  },
  "document": {
          "purpose": "Proposito_Compartilhamento_Documento",
      "documentId": "ID_documento",
          "files": [
              {
                  "data": "IMAGEM_Documento1"
              },
              { 
                  "data": "IMAGEM_Documento2"
              }
          ]
 },
 "imagebase64": "IMAGEM_SELFIE_Titular"
}

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso
Content-Type	String	Mandatório	"application/json"

• REQUEST BODY SCHEMA

Nome	Tipo	Mandatorio/Opcional	Descrição
subject.Code	String	Mandatório	CPF válido.
subject.Name	String	Mandatório	Nome da pessoa.
subject.Email	String	Opcional	Email da pessoa.
subject.Phone	String	Opcional	Telefone da pessoa.
document.Purpose	String	Mandatório	Indica o propósito do compartilhamento do documento. Deve ser enviado uma das opções a seguir: creditprocess: Enviado se o documento foi capturado para o propósito de um processo de concessão de credito. carpurchase: Enviado se o documento foi capturado em um processo de venda de veículo. paybypaycheck: Enviado se o documento foi capturado para o propósito de um processo de crédito consignado. onboarding: Enviado se o documento foi capturado para o propósito de um processo de onboarding. fgts: Enviado se o documento foi capturado para o propósito de um processo de concessão de credito através de fgts. Se os propósitos citados acima não condizem com seu cenário/fluxo existente, favor entrar em contato através da Central de Ajuda.
document.files	List	Mandatório	O files é uma lista de document.files.data porque pode ser necessário enviar mais de uma imagem para o mesmo documento. Exemplo: A foto do RG aberto (1 imagem) ou a foto da frente separada do verso (2 imagens).
document.documenId	String	Mandatório	ID do documento encontrado no "GetReusableDocuments" para ser reaproveitado
document.files.data	List	Mandatório	Imagem do documento. A imagem precisa ser em base64 (png, jpg, jpeg)
imagebase64	String	Mandatório	Foto da pesssoa física. A imagem precisa ser em base64 (png, jpg, jpeg)

Importante

• O valor do parâmetro document.documenId só será informado na requisição caso tenha encontrado um ID de documento na API "GetReusableDocuments".
• Caso não tenha encontrado nenhum ID de documento na API "GetReusableDocuments", você deve enviar o base64 do documento capturado como um valor do parâmetro document.files.data

Exemplo de requisição de Reaproveitamento:

{
    "subject": {
        "code": "45875596922",
        "name": "Roberto Flavio",
        "email": "random@unico.io",
        "phone": "5511999999999"
    },
    "document": {
        "purpose": "creditprocess",
        "documentId": "016ba203-ca11-4690-aeb7-3573c9a03936",
    },
    "imageBase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON como a seguir:

{
    "id": "016ba203-ca11-4690-aeb7-3573c9a03935",
    "status": 3,
    },
    "document": {
      "id": "aa58c722-15fa-44e4-9edc-59acf6c5ba57"
    }
}

Exemplo de requisição de Captura:

{
  "subject": {
    "code": "45875596922",
    "name": "Roberto Flavio",
    "email": "random@unico.io",
    "phone": "5511999999999"
  },
  "document": {
    "purpose": "creditprocess",
    "files": [
      {
        "data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
      }
    ]
  },
  "imageBase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON como a seguir:

{
    "id": "016ba203-ca11-4690-aeb7-3573c9a03935",
    "status": 3,
    },
    "document": {
      "id": "aa58c722-15fa-44e4-9edc-59acf6c5ba57"
    }
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
id	string	ID do processo. Esse ID será usado como referência para futuras consultas do processo
status	integer	Indica 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.id	string	Indica o ID do documento compartilhado ou criado

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": "10700",
        "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.