Especificação de parâmetros

Nesta seção, você encontrará a especificação de todos os parâmetros da API REST do meio de integração by Client

CreateProcess - Payload da requisição

Nome Tipo Obrigatório / Opcional Descrição

Nome	Tipo	Obrigatório / Opcional	Descrição
`subject.code`	string	Obrigatório	CPF válido do usuário.
`subject.name`	string	Obrigatório	Nome do usuário.
`subject.email`	string	Opcional	E-mail do usuário.
`subject.phone`	string	Opcional	Telefone do usuário. Ex.: `551190000-0000`
`useCase`	string	Opcional	É o caso de uso da operação de biometria. Ex: "Abertura de conta".
`imagebase64`	string	Obrigatório	É a selfie do usuário. A imagem precisa ser em base64 (png, jpg, jpeg). Caso utilize a Prova de vida com a SDK da Unico, deve-se enviar o arquivo `encrypted`. O `encrypted` deve ser enviado em até 10 minutos evitando que a imagem expire. E esse .jwt só pode ser usado uma única vez.
`referenceProcessId`	string	Obrigatório	Identificador do processo que foi gerado durante a criação da transação biométrica, cuja foto será usada para comparação. Este parâmetro é obrigatório somente ao utilizar a capacidade Validação (1:1).

subject.code

string

Obrigatório

CPF válido do usuário.

subject.name

string

Obrigatório

Nome do usuário.

subject.email

string

Opcional

E-mail do usuário.

subject.phone

string

Opcional

Telefone do usuário. Ex.: 551190000-0000

useCase

string

Opcional

É o caso de uso da operação de biometria. Ex: "Abertura de conta".

imagebase64

string

Obrigatório

É a selfie do usuário. A imagem precisa ser em base64 (png, jpg, jpeg).

Caso utilize a Prova de vida com a SDK da Unico, deve-se enviar o arquivo encrypted. O encrypted deve ser enviado em até 10 minutos evitando que a imagem expire. E esse .jwt só pode ser usado uma única vez.

referenceProcessId

string

Obrigatório

Identificador do processo que foi gerado durante a criação da transação biométrica, cuja foto será usada para comparação.

Este parâmetro é obrigatório somente ao utilizar a capacidade Validação (1:1).

{
  "subject": {
    "Code": "12345678909",
    "Name": "Luke Skywalker",
    "Email": "luke@gmail.com",
    "Phone": "5511999998888"
  },
  "useCase": "Abertura de conta",
  "imagebase64": "/9j/4AAQSkZJRg[...]p6qtRUZeUQf//Z"
}

GetProcess (Prova de vida + Verificação de Identidade) - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`id`		O identificador do processo.
`status`	string	Indica o status do processo. Pode receber os valores: `1`: Indica que o processo está em processamento. Pode ter uma ou mais capacidades que ainda não foram concluídas; `2`: Indica que o processo está em divergência (só ocorre quando há a utilização da capacidade Score de risco); `3`: Indica que o processo foi concluído. Todas as capacidades associadas ao processo tiveram seu processamento concluído. `4`: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada; `5`: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte. Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.
`unicoId.result`	string	Indica o resultado da capacidade Verificação de Identidade. Pode receber os valores: `yes`: Indica que a face é a do real titular do CPF. `no`: Indica que a face não é a do real titular. Caso receba esta resposta, não haverá a orquestração com a capacidade Score de risco, independentemente que a APIKey esteja configurada com ambas as capacidades. `inconclusive`: Indica que não foi possível determinar se a face é a do real titular do CPF. Caso haja orquestração com o Score de risco, devolveremos um score de probabilidade de risco no parâmetro `score`.
`liveness`	integer	Indica o resultado da capacidade Prova de vida. Pode receber os valores: `1`: Indica que o usuário o usuário estava ao vivo no momento da captura da selfie; `2`: Indica que o usuário não estava ao vivo no momento da captura da selfie. Caso utilize a solução sem a Prova de vida, o retorno sempre será `1`.
`score`	integer	Indica o resultado da capacidade Score de risco. Pode receber valores entre -90 e +95. O score só irá retornar no response da API caso a APIKey esteja devidamente configurada com a capacidade E a resposta da capacidade Verificação de Identidade tenha sido `inconclusive`.
`identityFraudsters.result`	string	Indica o resultado da capacidade Detecção de Perfil Fraudador. Pode receber os valores: `sim`: Indica que o usuário já esteve envolvido em transações fraudulentas de identidade; `inconclusive`: Indica que não foi possível encontrar transações fraudulentas associadas a esse usuário. Caso seja utilizada em conjunto com o Score de risco, a resposta `sim` fará com que o cadastro não seja derivado para o score.
`authenticated`	boolean	É o resultado da autenticação ao utilizar a capacidade Validação (1:1). Pode ser `true` ou `false`.
`government.serpro`	integer	Indica o resultado do score de similaridade da serpro.
`processAdditionalInfo.transactionId`	string	Indica o ID da transação do processo criado. Este ID está relacionado à selfie do usuário e não é o mesmo ID do processo (primeiro item relacionado neste descritivo).
`processAdditionalInfo.personName`	string	Indica o nome do usuário do processo criado.
`processAdditionalInfo.personDocument`	string	Indica o documento de identificação do usuário do processo criado.
`processAdditionalInfo.personImage`	string	Indica a imagem do usuário do processo criado.
`processAdditionalInfo.finishedAt`	string	Indica a data e hora do término do processo criado.

id

O identificador do processo.

status

string

Indica o status do processo. Pode receber os valores:

1: Indica que o processo está em processamento. Pode ter uma ou mais capacidades que ainda não foram concluídas;
2: Indica que o processo está em divergência (só ocorre quando há a utilização da capacidade Score de risco);
3: Indica que o processo foi concluído. Todas as capacidades associadas ao processo tiveram seu processamento concluído.
4: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada;
5: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte.

Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.

unicoId.result

string

Indica o resultado da capacidade Verificação de Identidade. Pode receber os valores:

yes: Indica que a face é a do real titular do CPF.
no: Indica que a face não é a do real titular. Caso receba esta resposta, não haverá a orquestração com a capacidade Score de risco, independentemente que a APIKey esteja configurada com ambas as capacidades.
inconclusive: Indica que não foi possível determinar se a face é a do real titular do CPF. Caso haja orquestração com o Score de risco, devolveremos um score de probabilidade de risco no parâmetro score.

liveness

integer

Indica o resultado da capacidade Prova de vida.

Pode receber os valores:

1: Indica que o usuário o usuário estava ao vivo no momento da captura da selfie;
2: Indica que o usuário não estava ao vivo no momento da captura da selfie.

Caso utilize a solução sem a Prova de vida, o retorno sempre será 1.

score

integer

Indica o resultado da capacidade Score de risco. Pode receber valores entre -90 e +95.

O score só irá retornar no response da API caso a APIKey esteja devidamente configurada com a capacidade E a resposta da capacidade Verificação de Identidade tenha sido inconclusive.

identityFraudsters.result

string

Indica o resultado da capacidade Detecção de Perfil Fraudador. Pode receber os valores:

sim: Indica que o usuário já esteve envolvido em transações fraudulentas de identidade;
inconclusive: Indica que não foi possível encontrar transações fraudulentas associadas a esse usuário.

Caso seja utilizada em conjunto com o Score de risco, a resposta sim fará com que o cadastro não seja derivado para o score.

authenticated

boolean

É o resultado da autenticação ao utilizar a capacidade Validação (1:1). Pode ser true ou false.

government.serpro

integer

Indica o resultado do score de similaridade da serpro.

processAdditionalInfo.transactionId

string

Indica o ID da transação do processo criado. Este ID está relacionado à selfie do usuário e não é o mesmo ID do processo (primeiro item relacionado neste descritivo).

processAdditionalInfo.personName

string

Indica o nome do usuário do processo criado.

processAdditionalInfo.personDocument

string

Indica o documento de identificação do usuário do processo criado.

processAdditionalInfo.personImage

string

Indica a imagem do usuário do processo criado.

processAdditionalInfo.finishedAt

string

Indica a data e hora do término do processo criado.

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "score": 50,
  "government"{
    "serpro": 50
  },
  "processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Luke Skywalker",
      "personDocument": "12345678909",
      "personImage": "https://api.datafortress.private.unico[...]OXc93D",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

GetProcess (Captura de documentos) - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`id`	string	Indica o ID do processo criado com o envio da foto.
`status`	integer	Indica o status do processo. Pode receber os valores: `1`: Indica que o processo está em processamento; `3`: Indica que o processo foi concluído; `4`: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada; `5`: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte. Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.
`document.id`	string	Indica o ID do documento criado.
`document.type`	string	Indica o tipo do documento retornado pela tipificação.
`document.cpfMatch`	string	Retorna 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.content`	list	Lista 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.fileUrls`	integer	Urls 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.

id

string

Indica o ID do processo criado com o envio da foto.

status

integer

Indica o status do processo. Pode receber os valores:

1: Indica que o processo está em processamento;

3: Indica que o processo foi concluído;
4: Indica que o processo foi cancelado. Ocorre quando a requisição é cancelada pelo cliente (ex: timeout) antes de ser devidamente processada;
5: Indica que houve algum erro no processamento. É recomendado que seja feito ao menos 3 novas tentativas e caso o erro persista, derivar para um fluxo de contingência e nos acionar nos canais de suporte.

Para o desenvolvimento correto da sua regra de negócio, só valide os resultados das capacidades IDCloud quando o status = 3.

document.id

string

Indica o ID do documento criado.

document.type

string

Indica o tipo do documento retornado pela tipificação.

document.cpfMatch

string

Retorna 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.content

list

Lista 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.fileUrls

integer

Urls 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.

{
  "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"
        ]
  }
}

GetReusableDocuments - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`items.documentType`	string	Tipo do documento encontrado.
`items.documentId`	string	ID do documento encontrado. Para reutilizar, deve-se usar esse id na chamada de Create Process.

items.documentType

string

Tipo do documento encontrado.

items.documentId

string

ID do documento encontrado. Para reutilizar, deve-se usar esse id na chamada de Create Process.

{
    "items": [{
        "documentType": "unico.moja.dictionary.br.rg.v2.Rg",
        "documentId": "2aaf6037-0153-415d-b9fe-cf7e8198408f"
    }]
}

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.

AnteriorCenários de response PróximoRecursos adicionais

Atualizado há 13 dias

CreateProcess - Payload da requisição

GetProcess (Prova de vida + Verificação de Identidade) - Response da requisição

GetProcess (Captura de documentos) - Response da requisição

GetReusableDocuments - Response da requisição

Dúvidas?​

Dúvidas?