Criar link de onboarding

Em desenvolvimento

BaaS API

https://api.brasilcash.com.br/baas

POST

/v1/onboards

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Sucesso

application/json

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.brasilcash.com.br/baas/v1/onboards' \
--header 'Content-Type: application/json' \
--data '{
  "inviteCode": null,
  "expirationDays": 30,
  "personTypeHint": "PF"
}'

Response Example

201 - Sucesso

{
  "linkToken": "Zk3pQ8vX1mN7rT2wY5bC",
  "onboard": {
    "id": "5c7e9a1b-2d4f-4e6a-8b0c-1d3e5f7a9b2c",
    "kycOnboardingLinkId": "5c7e9a1b-2d4f-4e6a-8b0c-1d3e5f7a9b2c",
    "personTypeHint": "PF",
    "status": "Created",
    "inviteCode": null,
    "applicantName": null,
    "stepsCompleted": 0,
    "stepsTotal": 4,
    "createdAt": "2026-10-19T12:00:00Z",
    "expiresAt": "2026-11-18T12:00:00Z",
    "onboardingUrl": "https://onboarding.brasilcash.com.br/o/Zk3pQ8vX1mN7rT2wY5bC"
  }
}

Modificado em 2026-10-19 03:18:29