KYB

O serviço de Identity permite que você gerencie o processo de integração de empresas, parceiros e colaboradores 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 Jurídicas, baseado em um de nossos fluxos de validação e retorna um identificador único da mesma.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Exemplo: kyb-cards
Enum: kyb-cardskyb-accountskyb-cards-additional
countrystringrequired
Exemplo: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Exemplo: API
Enum: API
dataobjectrequired
Detalhe de respostas
dataobject

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

POST/identity/v2/sessions
{
"flow_type":
"kyb-cards"
"country":
"BRA"
"integration_method":
"API"
"data":{
"company":{
...
}
"partners":[
...
]
}
}
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"
}
}

Criar Sessão - Adicional

O endpoint identity/v2/sessions permite criar uma nova sessão de validação de identidade para pessoas físicas (colaborador), associado ao Empresa o que antes tinha que ser validado.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Exemplo: kyb-cards-additional
Enum: kyb-cards-additionalkyb-cardskyb-accounts
countrystringrequired
Exemplo: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Exemplo: API
Enum: API
dataobjectrequired
Detalhe de respostas
dataobject

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

POST/identity/v2/sessions
{
"flow_type":
"kyb-cards-additional"
"country":
"BRA"
"integration_method":
"API"
"data":{
"company_id":
"cmp-f3d23x0n9USSNwSkP5G0gY1I2TO"
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"personal_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"
}
}

Carregar arquivo

O endpoint identity/v1/sessions/{session_id}/entities/{user_id or company_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 documento de identidade.

  • identity-card-back: foto do verso do documento de identidade.

  • company-document: dependendo do tipo da empresa, será necessário um tipo diferente de documentação.

Para o Brasil

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

  • identity-card-front: foto da frente do documento de identidade.

  • identity-card-back: foto do verso do documento de identidade.

  • driver-license-front: foto da frente da carteira de motorista.

  • driver-license-front: foto do verso da carteira de motorista.

  • company-document: Contrato social, Estatuto, Boletim de Subscrição, Contrato Social com Tradução Juramentada ou documento atualizado com registro que comprove a constituição da empresa.

Parâmetros disponíveis
Body Parameters
filestring(format: binary)required
Aceitamos arquivos de até 20MB
Path Parameters
user_idstring(format: uuid)required
Exemplo: usr-123e4567e89b12d3a456
company_idstring(format: uuid)required
Exemplo: cmp-123e4567e89b12d3a456
type_documentstringrequired
Exemplo: selfie
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-backcompany-document

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

POST/identity/v1/sessions/{uuid}/entities/{user_id|company_id}/files/{type_document}
{
"file":
"string"
}
Respostas de amostra
"ERROR":{
"message":
"src property must be a valid json object"
}

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/{uuid}
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/{uuid}
Respostas de amostra
{
"data":{
"id":
"123e4567-e89b-12d3-a456-426655440000"
"user_id":
"usr-123e4567e89b12d3a456"
"company_id":
"cmp-123e4567e89b12d3a456"
"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":
"kyb-banking"
}
}

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/{uuid}/report
Respostas de amostra
{
"data":{
"id":
"id de la session"
"company_data":{
...
}
"documentation_request":[
...
]
"documentation_proof":[
...
]
"partners":[
...
]
}
}

Buscar sessão

O endpoint /sessions permite pesquisar com filtros específicos.

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

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
filter[user_id]string
Exemplo: usr-34535dg-er2vd-234vsd234
filter[company_id]string
Exemplo: cmp-35bdg35-er2vd-fgddf35d2
filter[type]string
Exemplo: BUSINESS
Enum: BUSINESSCUSTOMER
filter[status]string
Exemplo: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEWVERIFIED
filter[created_at][from]string
ISO 8601
Exemplo: 1998-08-20
filter[created_at][to]string
ISO 8601
Exemplo: 1998-08-20
filter[sort]string
Enum: user_idstatuscreated_at
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":{
...
}
}
}