Listar onboardings do BaaS.

GET

/onboardings

Onboardings

Lista os processos de abertura de conta vinculados ao BaaS da credencial autenticada. Este endpoint é exclusivo para credenciais BaaS e não exige o cabeçalho x-account-id.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

baas.onboarding.read-Permite consultar cadastros/onboardings

Parâmetros de Consulta

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/onboardings?page=undefined&perPage=undefined&status=undefined&accountType=undefined&document=undefined&createdAtStart=undefined&createdAtEnd=undefined'

Response Example

200 - Exemplo 1

{
    "meta": {
        "total": 100,
        "limit": 10,
        "offset": 1
    },
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "accountType": "NATURAL_PERSON",
            "status": 0,
            "person": {
                "name": "string",
                "tradeName": "string",
                "document": "string",
                "email": "user@example.com",
                "phone": "string"
            },
            "company": {
                "name": "string",
                "tradeName": "string",
                "document": "string",
                "email": "user@example.com",
                "phone": "string"
            },
            "address": {
                "zipCode": "string",
                "address": "string",
                "number": "string",
                "complement": "string",
                "district": "string"
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ]
}

Página anterior

Enviar imagem do onboarding.

Próxima página

Consultar onboarding do BaaS.