Get Account Information

GET

/api/checking-account/{account}

Remember that in addition to the API key, you will need to sign the request. API Security and Authentication

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Body

🟠404Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://baas-api.np.bankei.com.br/api/checking-account/0298f43c-36d1-8c95-bf29-g3c929fe4d20' \
--header 'x-signature: ' \
--header 'x-timestamp: ' \
--header 'x-endpoint: ' \
--header 'x-org-id: ' \
--header 'x-api-key: <api-key>'

Response Example

200 - Success

{
    "checkingAccountId": "0298f43c-36d1-8c95-bf29-g3c929fe4d20",
    "accountId": "0298f43d-a517-9fe6-d5d3-0hc9f083eff9",
    "alias": "@admin::cliente-teste::98765432100/BRL",
    "userId": "0298f43e-18c5-9gb1-ce9e-c61gf77g86d2",
    "organizationId": "0298f43f-86f5-9097-0461-c5c73ec1g73f",
    "name": "Maria Oliveira",
    "accountNumber": "98765",
    "accountType": "checking",
    "bankCode": "406",
    "bankName": "ACCREDITO SCD S.A.",
    "branchCode": "0001",
    "taxId": "98765432100",
    "assetCode": "BRL",
    "userType": "Consumer"
}

Modified at 2026-01-12 11:51:52

Send KYC Document

Get Account Balance