43 - Gerar Link de Onboarding

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/GeraLinkCAFOnboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "webhookId": "<string>",
    "idLayout": "<string>",
    "naoExpira": true,
    "atributos": {
      "cpf": "<string>",
      "cnpj": "<string>"
    },
    "tipo": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

O Onboarding tem como objetivo apoiar os processos de compliance e prevenção a fraudes.

Ele compara os dados do documento enviado com as informações fornecidas pelo cliente e avalia a autenticidade do documento, verificando originalidade, possíveis manipulações e indícios de fraude.

O Onboarding pode ser realizado em qualquer momento da jornada do integrador, no início, para validar o cliente; durante a solicitação de crédito; ou ao final, para confirmar os dados fornecidos.

O processo é iniciado por um link gerado na requisição inicial, que leva o integrador a uma tela com etapas pré determinadas e customizáveis conforme a necessidade.

Mostrar Exemplo de retorno completo

O exemplo de retorno, mostrado no lado direito desta tela, está resumido. Na linha "json": "<string>" o retorno do Bureau vem de forma serializada, sendo necessário deserializar para melhor visualização. Aqui está um exemplo do retorno deserializado que vem no campo "json":.

{
    "Token": "String",
    "Status": {
        "Report": "String",
        "Uuid": "String",
        "StatusReasons": [
            {
                "Category": "String",
                "Description": "String",
                "ResultStatus": "String",
                "ResultCustomStatus": "String",
                "Code": "String",
                "Status": "String",
                "ManualReprovalReasons": "String"
            }
        ],
        "TemplateId": "String",
        "OnboardingId": "String",
        "Type": "String",
        "Date": "Date"
    }
}

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

Resposta

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

falha · boolean

json · string | null