Integração

Onboarding é um fluxo web oferecido pela Certta para obter dados e documentos de pessoas ou empresas, proporcionando agilidade e simplicidade no onboarding de novos usuários. O produto foi projetado para atender diferentes tipos de cadastro. Portanto, o fluxo/etapas e o layout podem ser totalmente personalizados de acordo com a preferência do cliente. Além disso, permitimos a criação de templates de onboarding ilimitados para que possam ser usados para diferentes finalidades.

O usuário final que precisa ser verificado iniciará as etapas de onboarding diretamente na página hospedada pela Certta, apresentada a ele por meio de uma URL de redirecionamento do cliente ou, alternativamente, via e-mail ou SMS (com o link de cadastro da Certta). Quando todas as etapas de cadastro definidas forem concluídas pelo usuário, uma transação será iniciada automaticamente com os dados obtidos, e uma resposta de callback com os dados do resultado será enviada para o seu webhook pré-configurado.

Cada link de onboarding pode ser criado pela API ou pela Certta Trust com associação a um template de onboarding e a um modelo de consulta de serviço pré-configurado.

Para detalhes sobre autenticação, acesse Autenticação.

Requisitos de autenticação:

Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
Para maior segurança, alguns endpoints também podem suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io
Para informações sobre a implementação de mTLS, acesse Usando mTLS

Create Web Onboarding link

post

/onboardings

Submission of the necessary person or company data and the template model against which the verification services shall be executed, as well as the set of rules to be validated.

Required Permission: Create Onboarding

Parâmetros de consulta

originstringObrigatório

Parameter that defines the onboarding origin. Must be set to Trust.

Default: TRUST

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Access token. See more in the 'Authentication' topic

Example: Bearer your_token_here

Corpo

typestring · enumObrigatório

Type of onboarding. Possible values are PF, PJ or PF_PF.

Example: PFValores possíveis:

transactionTemplateIdstringObrigatório

ID of the Query Template (configured in Trust Platform).

Example: 62b620ee3f07fb0009361111

templateIdstringOpcional

The ID of the onboarding template that will be used, If the value is not provided then the onboarding template already associated with the given Query Template in Trust Platform will be used otherwise Caf default onboarding template shall be the fallback.

Example: 6388ac6b409eff000804dadf

transactionPFTemplateIdstringOpcional

ID of the Query Template to be used in onboarding the related persons. Exclusive and required attribute for type PF_PF.

transactionQsaTemplateIdstringOpcional

ID of the Query Template to be used for onboarding company partners. Exclusive and required attribute for type PJ.

emailstring · emailOpcional

The email address that the onboarding web link will be sent to.

Example: [email protected]

smsPhoneNumberstringOpcional

The cell phone number to which the link from the Onboarding Web will be sent, we must use the format: [country code][number including area code] *The SMS service will be charged according to the number of sends in the billing month

Example: 5551999999999

noExpirebooleanOpcional

Set whether the weblink URL generated for the onboarding can be used only once or multiple times. When the value is set to true, the link will accept multiple registrations. By default, this is set to false.

Example: true

noNotificationbooleanOpcional

Optional field, which avoids triggering an email or sms. Recommended if you use our web onb. inside an iFrame or WebView. By default, this is set to false.

Example: false

metadataobjectOpcional

Additional information can be sent to the onboarding.

_callbackUrlstringOpcional

Callback URL (webhook).

Respostas

200

Success

application/json

requestIdstringOpcional

Unique identifier of request.

Example: 6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9

idstringOpcional

Unique identifier of created onboarding link.

Example: 6021a21b3811c35ecb8dea20

tokenstringOpcional

Token of created onboarding link.

Example: 0a8fb7b1c3eec7919967eXXXXXXXXXX

urlstringOpcional

URL link to access onboarding.

Example: https://link-onbording?token=0a8fb7b1c3eec7919967eXXXXXXXXXX

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/onboardings

POST /v1/onboardings?origin=TRUST HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 499

{
  "type": "PF",
  "transactionTemplateId": "62b620ee3f07fb0009361111",
  "templateId": "6388ac6b409eff000804dadf",
  "transactionPFTemplateId": null,
  "transactionQsaTemplateId": null,
  "email": "[email protected]",
  "smsPhoneNumber": "5551999999999",
  "noExpire": true,
  "noNotification": false,
  "variables": {
    "documentIssuedCountry": "SG"
  },
  "metadata": {},
  "_callbackUrl": "text",
  "attributes": {
    "name": "Jhon Doe",
    "birthDate": "dd/MM/yyyy",
    "cpf": "00011122233",
    "personId": "00011122233",
    "documentId": "DOC-00011122233",
    "cnpj": "00AAA222333344"
  }
}

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "id": "6021a21b3811c35ecb8dea20",
  "token": "0a8fb7b1c3eec7919967eXXXXXXXXXX",
  "url": "https://link-onbording?token=0a8fb7b1c3eec7919967eXXXXXXXXXX"
}

Atualizado há 6 meses