Listar Onboardings

Em desenvolvimento

BaaS API

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

GET

/v1/onboards

Requisição

Parâmetros de Consulta

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.brasilcash.com.br/baas/v1/onboards?page=1&pageSize=20&CreatedFrom={{%24date.future}}&CreatedTo={{%24date.future}}&PersonType=PF%20ou%20PJ'

Response Example

{
  "items": [
    {
      "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"
    },
    {
      "id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b",
      "kycOnboardingLinkId": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b",
      "personTypeHint": "PJ",
      "status": "InProgress",
      "inviteCode": "PARCEIRO-2026",
      "applicantName": "Padaria Pão Quente Ltda",
      "stepsCompleted": 2,
      "stepsTotal": 5,
      "createdAt": "2026-10-01T09:15:00Z",
      "expiresAt": "2026-11-30T09:15:00Z",
      "onboardingUrl": "https://onboarding.brasilcash.com.br/o/Hq9sL2kV6pD4xW8nF1gJ"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 2
}

Modificado em 2026-10-19 03:20:42

Página anterior

BrasilCash BaaS — API do Parceiro (v1)

Próxima página

Criar link de onboarding