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 Unico

CreateProcess - Payload da requisição

Nome Tipo Obrigatório / Opcional Descrição

Nome	Tipo	Obrigatório / Opcional	Descrição
`flow`	string	Obrigatório	Define a jornada que a ser executada. `idlive`: Fluxo com prova de vida, sem validação de identidade. `id`: Fluxo de validação de identidade com biometria facial. `idcheck`: Fluxo de validação de identidade com biometria facial com score no caso de inclonclusivo. `iddocs`: Fluxo de validação de identidade com captura e reaproveitamento de documentos (RG ou CNH). `idsign`: Fluxo de validação de identidade com assinatura eletrônica. `iddocssign`: Fluxo de validação de identidade, captura/reaproveitamento de documentos (RG ou CNH) e assinatura eletrônica. `idcheckserpro`: Fluxo de consulta no SERPRO e validação de identidade com biometria facial e score no caso de inconclusivo. `idtoken`: Fluxo para verificar a autenticidade de uma biometria facial em relação a um processo já realizado anteriormente.
`callbackUri`	string	Obrigatório	Define para onde o usuário será redirecionado ao fim do processo. URL: Você pode utilizar uma URL para uma página web de seu fluxo. Exemplo: `https://developers.unico.io/callback`. Você pode personalizar como desejar. URL Scheme: Você também pode realizar o redirecionamento para aplicações móveis nativas. Exemplo: `br.com.meupacote.app://callback`. Esse callback precisa estar registrado em sua aplicação móvel. Sem redirecionamento: Caso você esteja usando a solução em um fluxo de mensagem, utilize o valor `/` para evitar um redirecionamento ao final do fluxo. Para saber mais sobre como redirecionar o usuário, veja a seção
`person.personDuiType`	string	Obrigatório	Define o tipo de identificador do usuário. `DUI_TYPE_BR_CPF`: Para utilizar CPF como identificador.
`person.personDuiValue`	string	Obrigatório	Define o valor do identificador do usuário especificado no campo personDuiType. Exemplo: No caso de uso do identificador `DUI_TYPE_BR_CPF` para CPF utilize um CPF válido sem formatação: `73689290074`. Nota: Obrigatório nos fluxos de SMS e WhatsAPP.
`person.friendlyName`	string	Opcional	Define o nome do usuário. Ex.: `Luke Skywalker`.
`person.phone`	string	Opcional(*)	Define o telefone do usuário. Ex.: `551190000-0000`
`person.email`	string	Opcional(*)	Define o email do usuário.
`notifications.notificationChannel`	string	Opcional	`notifications`:É um array que define o canal de envio das notificações. O campo deve ser preenchido com as notificações desejadas: SMS, ou WhatsApp, ou os dois canais. Exemplo de uso: `notificationChannel`: `NOTIFICATION_CHANNEL_SMS` `notificationChannel`: `NOTIFICATION_CHANNEL_WHATSAPP` `notificationChannel`: `NOTIFICATION_CHANNEL_EMAIL` Não enviar campos de notifications em caso de recebimento de URL apenas.
`purpose`	string	Obrigatório	Define o propósito de uso e coleta de dados do usuário. Tem como objetivo dar transparência e garantir o tratamento de dados correto pela LGPD. `creditprocess`: Caso você esteja utilizando a solução para oferecer um crédito ao usuário. `biometryonboarding`: Caso você esteja utilizando a solução para realizar onboarding do usuário. `carpurchase`: Caso você esteja utilizando a solução para realizar commpra de um veículo.
`bioTokenId`	string	Opcional(**)	Define o Id da transação que deseja comparar com a validação do fluxo `idtoken`. O valor desse campo pode ser o valor do campo `id` ou `authenticationInfo.authenticationId` do processo retornado ao realizar o `GetProcess` de um processo `idcheck`.
`payload`	array	Obrigatório	O campo `payload` é um Array que oferece um local para inserção de arquivos necessários para alguns fluxos específicos, como por exemplo `idsign`. Dentro do Array `payload` outro Array pode ser utilizado para criação de envelopes de fluxo de assinatura. O campo `documents` é um Array recebe o documentos que compoem cada envelope, podendo ser 1 ou mais. Cada Objeto `document` possui: - `documentName`: Nome do documento. - `fileContents`: Base64 do PDF a ser assinado. Esse campo é obrigatório ao utilizar a capacidade Assinatura eletrônica.
`expiresIn`	string	Opcional	Esse campo define o tempo em segundos para a expiração do processo, baseado na data do created_at. Por exemplo, para a expiração ocorrer daqui 7 dias é necessário informar como `"expires_in": "10080s"`. Caso nenhum valor seja passado, será usado o valor default por cliente, se não existir esse valor, é usado o valor default de 7 dias.
`contextualization.price`	float	Opcional	Esse campo define o valor que será exibido na contextualização do processo.
`contextualization.currency`	string	Opcional(***)	Esse campo define a moeda que será usada para formatação do campo `price`.
`contextualization.locale.ptBr.Reason`	string	Opcional	Esse campo define a informação que será exibida no campo de `Motivo` do processo quando for selecionado a linguagem `pt-br`.
`contextualization.locale.enUs.Reason`	string	Opcional	Esse campo define a informação que será exibida no campo de `Motivo` do processo quando for selecionado a linguagem `en-us`.
`contextualization.locale.esMx.Reason`	string	Opcional	Esse campo define a informação que será exibida no campo de `Motivo` do processo quando for selecionado a linguagem `es-mx`.

flow

string

Obrigatório

Define a jornada que a ser executada. idlive: Fluxo com prova de vida, sem validação de identidade. id: Fluxo de validação de identidade com biometria facial. idcheck: Fluxo de validação de identidade com biometria facial com score no caso de inclonclusivo. iddocs: Fluxo de validação de identidade com captura e reaproveitamento de documentos (RG ou CNH). idsign: Fluxo de validação de identidade com assinatura eletrônica. iddocssign: Fluxo de validação de identidade, captura/reaproveitamento de documentos (RG ou CNH) e assinatura eletrônica.

idcheckserpro: Fluxo de consulta no SERPRO e validação de identidade com biometria facial e score no caso de inconclusivo. idtoken: Fluxo para verificar a autenticidade de uma biometria facial em relação a um processo já realizado anteriormente.

callbackUri

string

Obrigatório

Define para onde o usuário será redirecionado ao fim do processo. URL: Você pode utilizar uma URL para uma página web de seu fluxo. Exemplo: https://developers.unico.io/callback. Você pode personalizar como desejar. URL Scheme: Você também pode realizar o redirecionamento para aplicações móveis nativas. Exemplo: br.com.meupacote.app://callback. Esse callback precisa estar registrado em sua aplicação móvel. Sem redirecionamento: Caso você esteja usando a solução em um fluxo de mensagem, utilize o valor / para evitar um redirecionamento ao final do fluxo. Para saber mais sobre como redirecionar o usuário, veja a seção

person.personDuiType

string

Obrigatório

Define o tipo de identificador do usuário. DUI_TYPE_BR_CPF: Para utilizar CPF como identificador.

person.personDuiValue

string

Obrigatório

Define o valor do identificador do usuário especificado no campo personDuiType. Exemplo: No caso de uso do identificador DUI_TYPE_BR_CPF para CPF utilize um CPF válido sem formatação: 73689290074. Nota: Obrigatório nos fluxos de SMS e WhatsAPP.

person.friendlyName

string

Opcional

Define o nome do usuário. Ex.: Luke Skywalker.

person.phone

string

Opcional(*)

Define o telefone do usuário. Ex.: 551190000-0000

person.email

string

Opcional(*)

Define o email do usuário.

notifications.notificationChannel

string

Opcional

notifications:É um array que define o canal de envio das notificações. O campo deve ser preenchido com as notificações desejadas: SMS, ou WhatsApp, ou os dois canais. Exemplo de uso: notificationChannel: NOTIFICATION_CHANNEL_SMS notificationChannel: NOTIFICATION_CHANNEL_WHATSAPP

notificationChannel: NOTIFICATION_CHANNEL_EMAIL Não enviar campos de notifications em caso de recebimento de URL apenas.

purpose

string

Obrigatório

Define o propósito de uso e coleta de dados do usuário. Tem como objetivo dar transparência e garantir o tratamento de dados correto pela LGPD. creditprocess: Caso você esteja utilizando a solução para oferecer um crédito ao usuário. biometryonboarding: Caso você esteja utilizando a solução para realizar onboarding do usuário. carpurchase: Caso você esteja utilizando a solução para realizar commpra de um veículo.

bioTokenId

string

Opcional(**)

Define o Id da transação que deseja comparar com a validação do fluxo idtoken. O valor desse campo pode ser o valor do campo id ou authenticationInfo.authenticationId do processo retornado ao realizar o GetProcess de um processo idcheck.

payload

array

Obrigatório

O campo payload é um Array que oferece um local para inserção de arquivos necessários para alguns fluxos específicos, como por exemplo idsign. Dentro do Array payload outro Array pode ser utilizado para criação de envelopes de fluxo de assinatura. O campo documents é um Array recebe o documentos que compoem cada envelope, podendo ser 1 ou mais. Cada Objeto document possui: - documentName: Nome do documento. - fileContents: Base64 do PDF a ser assinado. Esse campo é obrigatório ao utilizar a capacidade Assinatura eletrônica.

expiresIn

string

Opcional

Esse campo define o tempo em segundos para a expiração do processo, baseado na data do created_at. Por exemplo, para a expiração ocorrer daqui 7 dias é necessário informar como "expires_in": "10080s". Caso nenhum valor seja passado, será usado o valor default por cliente, se não existir esse valor, é usado o valor default de 7 dias.

contextualization.price

float

Opcional

Esse campo define o valor que será exibido na contextualização do processo.

contextualization.currency

string

Opcional(***)

Esse campo define a moeda que será usada para formatação do campo price.

contextualization.locale.ptBr.Reason

string

Opcional

Esse campo define a informação que será exibida no campo de Motivo do processo quando for selecionado a linguagem pt-br.

contextualization.locale.enUs.Reason

string

Opcional

Esse campo define a informação que será exibida no campo de Motivo do processo quando for selecionado a linguagem en-us.

contextualization.locale.esMx.Reason

string

Opcional

Esse campo define a informação que será exibida no campo de Motivo do processo quando for selecionado a linguagem es-mx.

{
  "callbackUri": "/path/to/url",
  "flow": "iddocssign",
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074"
    "friendlyName": "Luke Skywalker",
    "phone": "5511974749090",
    "email": "luke@unico.io",
    "notifications":
    [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
      }
    ]
  },
  "purpose": "biometryonboarding",
  "expiresIn": "3600",
  "payload": [
    {
      "envelopePayload": {
        "documents": [
          {
            "documentName": "teste",
            "fileContents": "JVBERi0xLjMNCiXi48/[...]xNA0KJSVFT0YNCg=="
          }
        ]
      }
    }
  ]
}

GetProcess - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`id`	string	O identificador do processo.
`flow`	string	Indica a jornada que foi criada. `idlive`: Fluxo com prova de vida, sem validação de identidade. `id`: Fluxo de validação de identidade com biometria facial. `idcheck`: Fluxo de validação de identidade com biometria facial com score no caso de inclonclusivo. `iddocs`: Fluxo de validação de identidade com captura e reaproveitamento de documentos (RG ou CNH). `idsign`: Fluxo de validação de identidade com assinatura eletrônica. `iddocssign`: Fluxo de validação de identidade, captura/reaproveitamento de documentos (RG ou CNH) e assinatura eletrônica. `idcheckserpro`: Fluxo de consulta no SERPRO e validação de identidade com biometria facial e score no caso de inconclusivo. `idtoken`: Fluxo para verificar a autenticidade de uma biometria facial em relação a um processo já realizado anteriormente.
`callbackUri`	string	Indica para onde o usuário será redirecionado no fim do processo.
`userRedirectUrl`	string	Indica a URL para onde você deverá redirecionar o usuário para finalização da jornada.
`state`	string	Indica o estado atual do processo, por ser do tipo: `PROCESS_STATE_CREATED`: Processo criado e ainda não finalizado pelo usuário. `PROCESS_STATE_FINISHED`: Processo finalizado pelo usuário com sucesso. `PROCESS_STATE_FAILED`: Processo com erro.
`result`	string	Indica o resultado do processo da jornada do usuário, podendo ser do tipo: `PROCESS_RESULT_OK`: Processo finalizado com sucesso. `PROCESS_RESULT_ERROR`: Processo finalizado com algum tipo de erro. `PROCESS_RESULT_INVALID_IDENTITY`: Processo finalizado com com falha no liveness, ou resultado de inconclusivo quando flow = ID, ou quando no flow = IDCheck, houver uma divergência demorando mais que o tempo estabelecido. `PROCESS_RESULT_UNSPECIFIED`: É retornado quando o cliente utiliza o IDUnico sozinho. Processo finalizado com resultado não especificado.
`createdAt`	string	Sinaliza o momento em que o processo foi criado.
`finishedAt`	string	Sinaliza o momento em que o processo foi finalizado.
`person.personDuiType`	string	Indica o tipo de identificador do usuário. `DUI_TYPE_BR_CPF`: Para CPF como identificador.
`person.personDuiValue`	string	Indica o valor do identificador do usuário especificado no campo `personDuiType`.
`person.email`	string	Indica o valor e-mail do usuário especificado no campo `email` na criação do processo.
`person.phone`	string	Indica o valor telefone do usuário especificado no campo `phone` na criação do processo.
`person.friendlyName`	string	Indica o nome do usuário, por exemplo, `Luke Skywalker`.
`notifications.notificationChanell`	string	Indica qual foi o canal do envio das notificações na criação do processo.
`purpose`	string	Indica qual foi o propósito da coleta de dados do usuário no momento que o processo foi criado.
`authenticationInfo.authenticationResult`	string	Indica o resultado da validação de identidade pela capacidade Verificação de Identidade. `AUTHENTICATION_RESULT_UNSPECIFIED`: É retornado quando o cliente utiliza a Verificação de Identidade sozinha. Situações de retorno: - Não foi possível encontrar o usuário na base de autenticados; - Não houve retorno da orquestração com o Score de risco em tempo hábil (o by Unico aguarda até 60s pelas resoluções de divergências). `AUTHENTICATION_RESULT_INCONCLUSIVE`: Resultado de autenticação inconclusivo. `AUTHENTICATION_RESULT_POSITIVE`: Resultado de autenticação positivo.
`authenticationInfo.scoreEngineResult.scoreEnabled`	string	Indica se a capacidade Score de risco está habilitada nesta jornada.
`authenticationInfo.scoreEngineResult.score`	integer	Indica o Score de risco para os casos onde a resposta da Verificação de Identidade foi inconclusiva.
`authenticationInfo.authenticationId`	string	Indica o id do processo que derivou para Score de risco. Pode ser utilizado no flow idtoken, como um valor do parâmetro `bioTokenId`.
`authenticationInfo.livenessResult`	string	Indica o resultado do liveness. `LIVENESS_RESULT_UNSPECIFIED`: Retorno inesperado. `LIVENESS_RESULT_NOT_LIVE`: O usuário não passou na checagem de prova de vida. `LIVENESS_RESULT_LIVE`: Foi verificada a prova de vida do usuário.
`serproResult.score`	integer	Indica o resultado do score de similaridade da serpro. Atualmente só disponível para o flow `idcheckserpro`.
`services.documents.reused_doc`	boolean	Sinaliza se houve (`true`) ou não (`false`) reaproveitamento do documento. Um documento é reaproveitado quando já existe na base da dados da Unico e o usuário deu permissão para reutilizá-lo sem a necessidade de uma nova captura.
`services.documents.cpf_match`	boolean	Sinaliza se o CPF da requisição é o mesmo do documento. Se sim (`true`), se não (`false`).
`services.documents.typified`	boolean	Sinaliza se houve (`true`) ou não (`false`) a tipificação do documento. Um documento é tipificado quando é possível identificar o seu layout.
`services.documents.doc_id`	string	Identificador único do documento compartilhado.
`services.documents.signed_url`	string	Sinaliza a URL assinada do documento.
`services.documents.validate_doc`	boolean	Sinaliza se houve (`true`) ou não (`false`) validação do documento.
`services.documents.face_match`	boolean	Sinaliza se o a pessoa da foto da requisição é o mesma do documento. Se sim (`true`), se não (`false`).
`services.documents.doc.version`	integer	Sinaliza a versão do documento.
`services.documents.doc.data`	object	Quando tipificado o documento retornará os dados extraídos do documento: `RG`: numero, orgaoEmissor, ufEmissor, cpfNumero, carteiraProfissionalNumero, certificadoMilitarNumero, cnsNumero, nisPisPasepNumero, ctpsNumero, ctpsSerie, ctpsUf, tituloEleitorNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, naturalidade, dataEmissao. `CIN`: rgNumero, cpfNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, dataExpiracao, dataEmissao, orgaoEmissor, localEmissao, naturalidade, nacionalidade. `CNH`: numero, rgNumero, cpfNumero, nomeCivil, filiacao, dataNascimento, dataHabilitacao, dataExpiracao, dataEmissao, localEmissao, categoria, renachNumero.
`services.documents.doc.code`	string	Quando tipificado retornará RG, CIN ou CNH, quando não “Desconhecido" `RG`: Sinaliza que o documento compartilhado é do tipo RG. `CIN`: Sinaliza que o documento compartilhado é do tipo CIN. `CNH`: Sinaliza que o documento compartilhado é do tipo CNH. Um documento é tipificado quando é possível identificar o layout desse documento durante a captura da imagem.
`services.consent_granted`	boolean	Sinaliza se houve (`true`) ou não (`false`) consentimento do usuário.
`services.envelope_id`	string	Indica o identificador do envelope da Assinatura eletrônica.
`services.document_ids`	string	Indica o identificador do documento que foi assinado na jornada.
`capacities`	string	Indica quais capacidades IDCloud foram utilizadas no respectivo flow do processo. Pode ter os seguintes retornos: `PROCESS_CAPACITY_IDLIVE`; `PROCESS_CAPACITY_IDUNICO`; `PROCESS_CAPACITY_IDCHECK`; `PROCESS_CAPACITY_IDDOCS`; `PROCESS_CAPACITY_IDSIGN`; `PROCESS_CAPACITY_IDTOKEN`; `PROCESS_CAPACITY_IDSERPRO.`
`expiresAt`	string	Sinaliza o momento em que o processo será/foi expirado, o valor desse campo é calculado a partir do campo `expires_in` informado na criação do processo com a data de criação do process, `created_at`.

id

string

O identificador do processo.

flow

string

Indica a jornada que foi criada.

idlive: Fluxo com prova de vida, sem validação de identidade. id: Fluxo de validação de identidade com biometria facial. idcheck: Fluxo de validação de identidade com biometria facial com score no caso de inclonclusivo. iddocs: Fluxo de validação de identidade com captura e reaproveitamento de documentos (RG ou CNH). idsign: Fluxo de validação de identidade com assinatura eletrônica. iddocssign: Fluxo de validação de identidade, captura/reaproveitamento de documentos (RG ou CNH) e assinatura eletrônica.

callbackUri

string

Indica para onde o usuário será redirecionado no fim do processo.

userRedirectUrl

string

Indica a URL para onde você deverá redirecionar o usuário para finalização da jornada.

state

string

Indica o estado atual do processo, por ser do tipo: PROCESS_STATE_CREATED: Processo criado e ainda não finalizado pelo usuário. PROCESS_STATE_FINISHED: Processo finalizado pelo usuário com sucesso. PROCESS_STATE_FAILED: Processo com erro.

result

string

Indica o resultado do processo da jornada do usuário, podendo ser do tipo: PROCESS_RESULT_OK: Processo finalizado com sucesso. PROCESS_RESULT_ERROR: Processo finalizado com algum tipo de erro. PROCESS_RESULT_INVALID_IDENTITY: Processo finalizado com com falha no liveness, ou resultado de inconclusivo quando flow = ID, ou quando no flow = IDCheck, houver uma divergência demorando mais que o tempo estabelecido. PROCESS_RESULT_UNSPECIFIED: É retornado quando o cliente utiliza o IDUnico sozinho. Processo finalizado com resultado não especificado.

createdAt

string

Sinaliza o momento em que o processo foi criado.

finishedAt

string

Sinaliza o momento em que o processo foi finalizado.

person.personDuiType

string

Indica o tipo de identificador do usuário. DUI_TYPE_BR_CPF: Para CPF como identificador.

person.personDuiValue

string

Indica o valor do identificador do usuário especificado no campo personDuiType.

person.email

string

Indica o valor e-mail do usuário especificado no campo email na criação do processo.

person.phone

string

Indica o valor telefone do usuário especificado no campo phone na criação do processo.

person.friendlyName

string

Indica o nome do usuário, por exemplo, Luke Skywalker.

notifications.notificationChanell

string

Indica qual foi o canal do envio das notificações na criação do processo.

purpose

string

Indica qual foi o propósito da coleta de dados do usuário no momento que o processo foi criado.

authenticationInfo.authenticationResult

string

Indica o resultado da validação de identidade pela capacidade Verificação de Identidade. AUTHENTICATION_RESULT_UNSPECIFIED: É retornado quando o cliente utiliza a Verificação de Identidade sozinha. Situações de retorno: - Não foi possível encontrar o usuário na base de autenticados; - Não houve retorno da orquestração com o Score de risco em tempo hábil (o by Unico aguarda até 60s pelas resoluções de divergências). AUTHENTICATION_RESULT_INCONCLUSIVE: Resultado de autenticação inconclusivo. AUTHENTICATION_RESULT_POSITIVE: Resultado de autenticação positivo.

authenticationInfo.scoreEngineResult.scoreEnabled

string

Indica se a capacidade Score de risco está habilitada nesta jornada.

authenticationInfo.scoreEngineResult.score

integer

Indica o Score de risco para os casos onde a resposta da Verificação de Identidade foi inconclusiva.

authenticationInfo.authenticationId

string

Indica o id do processo que derivou para Score de risco. Pode ser utilizado no flow idtoken, como um valor do parâmetro bioTokenId.

authenticationInfo.livenessResult

string

Indica o resultado do liveness. LIVENESS_RESULT_UNSPECIFIED: Retorno inesperado.

LIVENESS_RESULT_NOT_LIVE: O usuário não passou na checagem de prova de vida.

LIVENESS_RESULT_LIVE: Foi verificada a prova de vida do usuário.

serproResult.score

integer

Indica o resultado do score de similaridade da serpro. Atualmente só disponível para o flow idcheckserpro.

services.documents.reused_doc

boolean

Sinaliza se houve (true) ou não (false) reaproveitamento do documento.

Um documento é reaproveitado quando já existe na base da dados da Unico e o usuário deu permissão para reutilizá-lo sem a necessidade de uma nova captura.

services.documents.cpf_match

boolean

Sinaliza se o CPF da requisição é o mesmo do documento. Se sim (true), se não (false).

services.documents.typified

boolean

Sinaliza se houve (true) ou não (false) a tipificação do documento.

Um documento é tipificado quando é possível identificar o seu layout.

services.documents.doc_id

string

Identificador único do documento compartilhado.

services.documents.signed_url

string

Sinaliza a URL assinada do documento.

services.documents.validate_doc

boolean

Sinaliza se houve (true) ou não (false) validação do documento.

services.documents.face_match

boolean

Sinaliza se o a pessoa da foto da requisição é o mesma do documento. Se sim (true), se não (false).

services.documents.doc.version

integer

Sinaliza a versão do documento.

services.documents.doc.data

object

Quando tipificado o documento retornará os dados extraídos do documento: RG: numero, orgaoEmissor, ufEmissor, cpfNumero, carteiraProfissionalNumero, certificadoMilitarNumero, cnsNumero, nisPisPasepNumero, ctpsNumero, ctpsSerie, ctpsUf, tituloEleitorNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, naturalidade, dataEmissao. CIN: rgNumero, cpfNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, dataExpiracao, dataEmissao, orgaoEmissor, localEmissao, naturalidade, nacionalidade. CNH: numero, rgNumero, cpfNumero, nomeCivil, filiacao, dataNascimento, dataHabilitacao, dataExpiracao, dataEmissao, localEmissao, categoria, renachNumero.

services.documents.doc.code

string

Quando tipificado retornará RG, CIN ou CNH, quando não “Desconhecido" RG: Sinaliza que o documento compartilhado é do tipo RG. CIN: Sinaliza que o documento compartilhado é do tipo CIN. CNH: Sinaliza que o documento compartilhado é do tipo CNH. Um documento é tipificado quando é possível identificar o layout desse documento durante a captura da imagem.

services.consent_granted

boolean

Sinaliza se houve (true) ou não (false) consentimento do usuário.

services.envelope_id

string

Indica o identificador do envelope da Assinatura eletrônica.

services.document_ids

string

Indica o identificador do documento que foi assinado na jornada.

capacities

string

Indica quais capacidades IDCloud foram utilizadas no respectivo flow do processo. Pode ter os seguintes retornos: PROCESS_CAPACITY_IDLIVE; PROCESS_CAPACITY_IDUNICO; PROCESS_CAPACITY_IDCHECK; PROCESS_CAPACITY_IDDOCS; PROCESS_CAPACITY_IDSIGN; PROCESS_CAPACITY_IDTOKEN; PROCESS_CAPACITY_IDSERPRO.

expiresAt

string

Sinaliza o momento em que o processo será/foi expirado, o valor desse campo é calculado a partir do campo expires_in informado na criação do processo com a data de criação do process, created_at.

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocssign",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS",
            "PROCESS_CAPACITY_IDSIGN",
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "services": [
            {
                "documents": [
                    {
                        "doc": {
                            "version": 2,
                            "code": "RG",
                            "data": {
                                "dataExpiracao": "2025-10-35T00:00:00Z",
                                "dataHabilitacao": "2022-08-09T00:00:00Z",
                                "dataNascimento": "1950-06-30T00:00:00Z",
                                "nomeCivil": "John Doe",
                                "rgNumero": "5478854",
                                "categoria": "D",
                                "cpfNumero": "73689290074",
                                "dataEmissao": "2020-08-09T00:00:00Z",
                                "localEmissao": "DEREX SP",
                                "numero": "85775532778",
                                "renachNumero": ""
                            },
                        },
                        "typified": true,
                        "cpf_match": true,
                        "face_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            },
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]
            }
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2023-10-09T15:15:25.417105Z"
    }
}

GetSelfie - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`fileContents`	string	O É um string codificado em Base64 que deve ser convertido para um arquivo de imagem em sua aplicação.
`contentType`	string	Indica que conteúdo em fileContents é uma imagem jpeg ou png.

fileContents

string

O É um string codificado em Base64 que deve ser convertido para um arquivo de imagem em sua aplicação.

contentType

string

Indica que conteúdo em fileContents é uma imagem jpeg ou png.

{
  "fileContents": "/9j/4AAQSkZJRgABAQA[...]QkeQUjE",
  "contentType": "image/jpeg"
}

GetEvidenceSet - Response da requisição

Nome Tipo Descrição

Nome	Tipo	Descrição
`fileContents`	string	É um string codificado em Base64 que deve ser convertido para um arquivo PDF em sua aplicação
`contentType`	string	Indica que conteúdo em fileContents é um pdf.

fileContents

string

É um string codificado em Base64 que deve ser convertido para um arquivo PDF em sua aplicação

contentType

string

Indica que conteúdo em fileContents é um pdf.

{
  "fileContents": "JVBERi0xLjUNCiWDk[...]NCg==",
  "contentType": "x-pdf"
}

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 - Response da requisição

GetSelfie - Response da requisição

GetEvidenceSet - Response da requisição

Dúvidas?​

Dúvidas?