1 de 8

APIs

Nesta seção, você encontrará todas as APIs REST disponíveis para utilização do meio de integração by Client

CreateProcess

Nesta seção, você encontrará como criar um processo no by Client através da API REST

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Os parâmetros acima são os da utilização mais comum da API, mas podem sofrer alterações a depender das capacidades que estiver utilizando. Confira nas subseções desta seção as possibilidades de capacidades e suas diferenças.

Responses de erro

A API by Client não recusa as fotos (ou seja, não há drop). Os retornos existentes são da capacidade Verificação de Identidade e sempre serão: yes, no ou inconclusive. Sendo assim, os casos de má qualidade na captura da imagem, prova de vida ou não titularidade, o retorno é inconclusive. O retorno é um yes quando é possível identificar uma pessoa ao vivo e que seja a real titular do CPF.

Prova de vida

Nesta seção, você encontrará as particularidades de criar um processo que tenha somente a Prova de vida como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

Note que para utilizar a Prova de vida de forma isolada:

Na criação do processo, somente o subject.code e imageBase64 são obrigatórios;
No response do processo, só devolvemos os parâmetros id, status e liveness (resultado da Prova de vida).

Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.

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.

Verificação de Identidade

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Verificação de Identidade como capacidade, bem como seus complementos

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

Note que para a utilização da capacidade de Verificação de Identidade:

Na criação do processo, são obrigatórios subject.code, subject.name e imageBase64;
No response do processo, as respostas das capacidades podem vir em tempos diferentes, visto que o IDCloud possui Capacidades síncronas e assíncronas. Em função disso, deve-se implementar o método GetProcess a depender da combinação destas capacidades.

A capacidade de Verificação de Identidade pode ser combinada com outras capacidades, como Score de risco ou Detecção de Perfil Fraudador. Para encontrar mais informações das respostas possíveis, veja as seções Cenários de response e Especificação de Parâmetros.

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.

Validação (1:1)

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Validação (1:1) como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

Note que para a utilização da capacidade de Validação (1:1):

Na criação do processo, são obrigatórios subject.code, referenteProcessId e imageBase64;
No response do processo, devolvemos o id, authenticated (resultado da Validação 1:1) e liveness (resultado da Prova de vida).

Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.

O endpoint acima considera o uso da capacidade Validação (1:1) em conjunto com a capacidade Prova de vida.

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.

Captura de documentos

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Captura de documentos como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

Note que para a utilização da capacidade de Captura de documentos:

Na criação do processo, são obrigatórios subject.code, subject.name, document.Purpose, document.files.documentId ou document.files.data e imageBase64;
- 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
No response do processo, devolvemos o id, status e o document.id. A resposta da capacidade é sempre assíncrona, portanto deve-se implementar o método GetProcess.

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.

GetProcess

Nesta seção, você encontrará como obter o resultado de um processo no by Client através da API REST

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Para entender mais sobre as combinações de capacidades, veja também a seção Cenários de response.

No endpoint da v2 (/processes/v2/{id}), também devolvemos algumas informações adicionais do usuário, conforme exemplo abaixo:

"processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

Responses de erro

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.

GetReusableDocuments

Nesta seção, você encontrará como obter o documento para ser reaproveitado no by Client através da API REST

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Captura de documentos

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Captura de documentos como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

CreateProcess

Endpoint para criar um novo processo de documentos no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade de captura e reaproveitamento de documentos.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

document*object

Informações sobre o documento que será capturado.

purpose*string

Indica o propósito do compartilhamento do documento. Pode receber os valores: creditprocess, carpurchase, paybypaycheck, onboarding ou fgts

authProcessId*string

ID do processo de biometria que deve ter sido realizado anteriormente. O ID deve ser de um processo concluído com uma biometria válida.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

documentId*string

É o identificador do documento para ser reaproveitado. Você o encontrará ao utilizar a API GetReusableDocuments. Caso não encontre um documento para ser reaproveitado, deve-se capturar o documento e enviar o base64 no parâmetro data.files.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

files*array of object

Base64 do documento do usuário caso não encontre um para ser reaproveitado na API GetReusableDocuments. O array pode conter 1 arquivo (ex: CNH inteira) ou 2 arquivos (ex: CNH frente e CNH verso)

datastring

Imagem do documento codificada em base64.

Example: "/9j/4AAQSkZJR..."

imageBase64*string

Base64 da selfie do usuário.

Example: "/9j/4AAQSkZJR..."

Response

Processo de documento criado com sucesso.

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 3

documentobject

idstring

ID do documento que foi criado.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "document": {
        "purpose": null,
        "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "documentId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "files": [
          {}
        ]
      },
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "document": {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6"
  }
}

Note que para a utilização da capacidade de Captura de documentos:

Na criação do processo, são obrigatórios subject.code, subject.name, document.Purpose, document.files.documentId ou document.files.data e imageBase64;
- 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
No response do processo, devolvemos o id, status e o document.id. A resposta da capacidade é sempre assíncrona, portanto deve-se implementar o método GetProcess.

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.

Prova de vida

Nesta seção, você encontrará as particularidades de criar um processo que tenha somente a Prova de vida como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

CreateProcess

Endpoint para criar um novo processo de prova de vida no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade prova de vida.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

imageBase64*string

Encrypted gerado pelo SDK.

Example: "/9j/4AAQSkZJR..."

Response

Processo criado com sucesso (Usuário ao vivo).

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 3

livenessinteger

Resultado da prova de vida.

Example: 1

Request

Response

Note que para utilizar a Prova de vida de forma isolada:

Na criação do processo, somente o subject.code e imageBase64 são obrigatórios;
No response do processo, só devolvemos os parâmetros id, status e liveness (resultado da Prova de vida).

Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.

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.

Validação (1:1)

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Validação (1:1) como capacidade

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

CreateProcess

Endpoint para criar um novo processo de validação 1:1 no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade validação 1:1.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

referenceProcessId*string

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

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

imageBase64*string

Encrypted gerado pelo SDK.

Example: "/9j/4AAQSkZJR..."

Response

Processo criado com sucesso (Usuário autenticado).

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

authenticatedboolean

Resultado da autenticação.

Example: true

livenessinteger

Resultado da prova de vida.

Example: 1

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909"
      },
      "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "authenticated": true,
  "liveness": 1
}

Note que para a utilização da capacidade de Validação (1:1):

Na criação do processo, são obrigatórios subject.code, referenteProcessId e imageBase64;
No response do processo, devolvemos o id, authenticated (resultado da Validação 1:1) e liveness (resultado da Prova de vida).

Para este caso de uso, não há a necessidade de realizar o GetProcess, visto que a resposta é síncrona.

O endpoint acima considera o uso da capacidade Validação (1:1) em conjunto com a capacidade Prova de vida.

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.

Verificação de Identidade

Nesta seção, você encontrará as particularidades de criar um processo que tenha a Verificação de Identidade como capacidade, bem como seus complementos

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

CreateProcess

Endpoint para criar um novo processo de verificação de identidade no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com as capacidades que irá utilizar.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

useCase*string

Caso de uso da operação.

Example: "Onboarding"

imageBase64*string

Encrypted gerado pelo SDK ou base64.

Example: "/9j/4AAQSkZJR..."

Response

Processo criado com sucesso (INCONCLUSIVO da Verificação de Identidade).

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 2

unicoIdobject

resultstring

Resultado da verificação de identidade.

Example: "inconclusive"

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "useCase": "Onboarding",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 2,
  "unicoId": {
    "result": "inconclusive"
  }
}

Note que para a utilização da capacidade de Verificação de Identidade:

Na criação do processo, são obrigatórios subject.code, subject.name e imageBase64;
No response do processo, as respostas das capacidades podem vir em tempos diferentes, visto que o IDCloud possui Capacidades síncronas e assíncronas. Em função disso, deve-se implementar o método GetProcess a depender da combinação destas capacidades.

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.

GetProcess

Nesta seção, você encontrará como obter o resultado de um processo no by Client através da API REST

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.id.uat.unico.app/processes/v1;
Produção: https://api.id.unico.app/processes/v1.

GetProcess

Endpoint para buscar o resultado de um processo de verificação de identidade no by Client.

GEThttps://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}

Path parameters

processId*string

ID do processo.

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida.

Response

Informações do processo obtidas com sucesso.

Body

idstring

ID do processo.

Example: "2b034568-dfaf-463f-94fb-18ed93c312e8"

statusinteger

Status do processo.

Example: 3

unicoIdobject

Resultado do verificação de identidade.

resultstring

Resultado da verificação de identidade.

Example: "inconclusive"

livenessinteger

Resultado da prova de vida, onde: '1' é LIVE e '2' é NOT LIVE.

Example: 1

scoreinteger

Resultado do score de risco.

Example: 50

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Para entender mais sobre as combinações de capacidades, veja também a seção Cenários de response.

No endpoint da v2 (/processes/v2/{id}), também devolvemos algumas informações adicionais do usuário, conforme exemplo abaixo:

"processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

Responses de erro

code

message

Descrição

code

message

Descrição

code

message

Descrição

code

message

Descrição

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.

CreateProcess

Endpoint para criar um novo processo de verificação de identidade no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com as capacidades que irá utilizar.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

useCase*string

Caso de uso da operação.

Example: "Onboarding"

imageBase64*string

Encrypted gerado pelo SDK ou base64.

Example: "/9j/4AAQSkZJR..."

Response

Processo criado com sucesso (INCONCLUSIVO da Verificação de Identidade).

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 2

unicoIdobject

resultstring

Resultado da verificação de identidade.

Example: "inconclusive"

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "useCase": "Onboarding",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 2,
  "unicoId": {
    "result": "inconclusive"
  }
}

CreateProcess

Endpoint para criar um novo processo de documentos no by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Authorization*string

Access-token válido.

APIKEY*string

APIKEY válida com a capacidade de captura e reaproveitamento de documentos.

Body

subject*object

code*string

CPF do usuário.

Example: "12345678909"

name*string

Nome do usuário.

Example: "Luke Skywalker"

emailstring

E-mail do usuário.

Example: "luke@unico.io"

phonestring

Telefone do usuário.

Example: "551972557070"

document*object

Informações sobre o documento que será capturado.

purpose*string

Indica o propósito do compartilhamento do documento. Pode receber os valores: creditprocess, carpurchase, paybypaycheck, onboarding ou fgts

authProcessId*string

ID do processo de biometria que deve ter sido realizado anteriormente. O ID deve ser de um processo concluído com uma biometria válida.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

documentId*string

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

files*array of object

Base64 do documento do usuário caso não encontre um para ser reaproveitado na API GetReusableDocuments. O array pode conter 1 arquivo (ex: CNH inteira) ou 2 arquivos (ex: CNH frente e CNH verso)

datastring

Imagem do documento codificada em base64.

Example: "/9j/4AAQSkZJR..."

imageBase64*string

Base64 da selfie do usuário.

Example: "/9j/4AAQSkZJR..."

Response

Processo de documento criado com sucesso.

Body

idstring

ID do processo.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusinteger

Status do processo.

Example: 3

documentobject

idstring

ID do documento que foi criado.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

Request

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "document": {
        "purpose": null,
        "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "documentId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
        "files": [
          {}
        ]
      },
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "document": {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6"
  }
}

APIs

CreateProcess

Antes de começar

Endpoints:

Responses de erro

Prova de vida

Antes de começar

Endpoints:

Dúvidas?​

Verificação de Identidade

Antes de começar

Endpoints:

Dúvidas?​

Validação (1:1)

Antes de começar

Endpoints:

Dúvidas?​

Captura de documentos

Antes de começar

Endpoints:

Dúvidas?​

GetProcess

Antes de começar

Endpoints:

Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a reposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Responses de erro

Dúvidas?​

GetReusableDocuments

Antes de começar

Endpoints:

Captura de documentos

Antes de começar

Endpoints:

CreateProcess

Dúvidas?​

Prova de vida

Antes de começar

Endpoints:

CreateProcess

Dúvidas?​

Validação (1:1)

Antes de começar

Endpoints:

CreateProcess

Dúvidas?​

Verificação de Identidade

Antes de começar

Endpoints:

CreateProcess

Dúvidas?​

GetProcess

Antes de começar

Endpoints:

GetProcess

Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a reposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Responses de erro

Dúvidas?​

GetReusableDocuments

Antes de começar

Endpoints:

Dúvidas?

CreateProcess

Antes de começar

Endpoints:

Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a reposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão. Veja mais sobre os possíveis status na seção .

Responses de erro

Dúvidas?

Dúvidas?

Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a reposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão. Veja mais sobre os possíveis status na seção .

Dúvidas?

GetReusableDocuments

CreateProcess

CreateProcess

GetReusableDocuments

GetProcess

CreateProcess

CreateProcess

CreateProcess

CreateProcess

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Dúvidas?

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção .

Para implementar suas regras de negócio, sempre valide os status finais dos processos (`3`,`4`,`5`). Para validar a reposta das capacidades IDCloud, só considere o `status` = `3` para sua tomada de decisão. Veja mais sobre os possíveis status na seção .