KYC

O serviço de Identity permite que você gerencie o processo de integração de seus usuários de forma ágil e simples, confirmando sua identidade e prevenindo fraudes.

Criar sessão

O endpoint identity/v2/sessions permite criar uma nova sessão de validação de identidade para pessoas físicas, baseado em um de nossos fluxos de validação e retorna um identificador único da mesma.

Ponto importante a se considerar sobre o método de integração via API

Ao usar esse tipo de integração, os documentos são carregados com o endpoint Carregar arquivo

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Exemplo: kyc-accounts
Enum: kyc-accounts
countrystringrequired
Exemplo: ARG
Enum: ARGBRACHL
integration_methodstringrequired
Integration Method
Exemplo: API
Enum: APIWEB
dataobjectrequired
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/identity/v2/sessions
{
"flow_type":
"kyc-accounts"
"country":
"ARG"
"integration_method":
"API"
"data":{
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"personal_data":{
...
}
"terms_data":{
...
}
}
}
Respostas de amostra
{
"data":{
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
"url":
"https://identity.pomelo.com/session/497f ..."
}
}

Carregar arquivo

O endpoint identity/v1/sessions/{session_id}/entities/{user_id}/files/{type_document} será usado em conjunto com os de “Criação de Sessão”. O objetivo do mesmo é poder carregar os documentos de suporte que são necessários dependendo de cada tipo de sessão.

Os tipos de documentos aceitos são:

Para Argentina

selfie: Foto do rosto da pessoa que deseja validar a sessão.

  • identity-card-front: Foto da frente do RG.

  • identity-card-back: Foto do verso do RG.

Para o Brasil

selfie: Foto do rosto da pessoa que deseja validar a sessão.

  • identity-card-front: Foto da frente do RG.

  • identity-card-back: Foto do verso do RG.

  • driver-license-front: Foto da frente da CNH.

  • driver-license-back: Foto do verso da CNH.

Parâmetros disponíveis
Body Parameters
filestring(format: binary)required
Aceitamos arquivos de até 20MB
Path Parameters
session_idstring(format: uuid)required
Exemplo: iss-123e4567e89b12d3a456
user_idstringrequired
Exemplo: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
type_documentstringrequired
Exemplo: identity-card-front
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-back
Detalhe de respostas

Esta seção foi útil para você?

POST/identity/v1/sessions/{session_id}/entities/{user_id}/files/{type_document}
{
"file":
"string"
}
Respostas de amostra
{}

Limpar usuário em ambiente de teste

O endpoint /clean_validations permite “limpar” os dados de um usuário em ambiente de teste para que seja possível criar uma nova sessão usando o mesmo documento.

Considerações

Será preciso especificar o ID ou o número de documento do usuário que você deseja limpar. Caso sejam enviadas as duas informações, será dada prioridade ao ID do usuário para a limpeza.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
user_idstring
ID do usuário
Exemplo: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
document_idstring(format: int64)
DOCUMENT ID
Exemplo: 2038199391
Detalhe de respostas

Esta seção foi útil para você?

POST/identity/v1/clean_validations
{
"user_id":
"<UserId>"
"document_id":
"<DNI or CPF>"
}
Respostas de amostra

Cancelar sessão

O endpoint identity/v1/session/{session_id} permite que você cancele uma sessão de validação de identidade.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
uuidstring(format: uuid)required
Session ID
Detalhe de respostas

Esta seção foi útil para você?

DELETE/identity/v1/sessions/{session_id}
Respostas de amostra

Obter sessão

O endpoint identity/v1/sessions/{session_id} permite que você obtenha dados de uma sessão de validação de identidade.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
uuidrequired
Session ID
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/identity/v1/sessions/{session_id}
Respostas de amostra
{
"data":{
"id":
"123e4567-e89b-12d3-a456-426655440000"
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"expiration_at":
"2021-07-28T14:04:31-03:00"
"created_at":
"2021-07-28T14:04:31-03:00"
"status":
"CREATED"
"steps":[
...
]
"failed_reasons":[
...
]
"flow_type":
"default"
}
}

Obter relatório de sessão

O endpoint identity/v1/sessions/{session_id}/report permite que você obtenha dados de uma sessão de validação de identidade.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
uuidstringrequired
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/identity/v1/sessions/{session_id}/report
Respostas de amostra
{
"data":{
"id":
"id de la session"
"document_data":{
...
}
"person_data":{
...
}
"identity_proof":{
...
}
"manual_review":{
...
}
}
}

Buscar sessão

O endpoint /sessions permite realizar uma pesquisa com filtros específicos.

Considerações

Será necessário especificar os filtros desejados como parâmetros de acordo com o seguinte padrão: filter[field]=value. Por exemplo: filter[status]=IN_PROGRESS

Os resultados serão fornecidos por página. É possível especificar a quantidade de dados por página e também qual página se deseja visualizar.

Período

Há um filtro para o campo created_at, que pode er usado para obter as sessões criadas dentro de um intervalo de datas. Por exemplo: filter[created_at][from]=2021-07-27&filter[created_at][to]=2021-07-28

Ordenação

É possível especificar a ordem dos resultados com certos parâmetros que deverão ser enviados como uma lista de strings no filtro do tipo sort. Por exemplo: ?sort=created_at,updated_at.

A ordenação padrão será crescente. Para especificar uma ordem decrescente, deve-se enviar o caractere '-' como prefixo do atributo. Por exemplo: ?sort=created_at,-updated_at.

Se um parâmetro estiver errado ou mal redigido, responderemos com um erro.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
filter[user_id]string
filter[status]string
Exemplo: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEWEXPIREDVERIFIED
filter[created_at][from]string
ISO 8601
Exemplo: 1998-08-20
filter[created_at][to]string
ISO 8601
Exemplo: 1998-08-20
page[size]number
page[number]number
sortstring
Exemplo: -created_at
Enum: created_atupdated_at
Detalhe de respostas
dataarray
metaobject

Esta seção foi útil para você?

GET/identity/v1/sessions
Respostas de amostra
{
"data":[
0:{
...
}
]
"meta":{
"filters":[
...
]
"pagination":{
...
}
}
}