API Reference
  1. Account Management
  2. Sub-account Management

Perform a credit check on a sub-account

post
https://{domain}/api/main-account/sub-accounts//credit-checks

Requests a fresh or retrieves a recent credit check for the specified sub-account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
⚠️

IMPORTANT

Frequent credit checks will impact the customer's credit score. To protect customers, a mechanism is in place to prevent repeat credit checks on the same user within 90 days. This guard can be overridden if absolutely necessary.

Path Params
uuid
required

ID of the sub-account to be checked.

Query Params
boolean
Defaults to false

If true, bypasses the check for a recent (last 90 days) credit report and forces a new one. If false, the request fails if a recent report already exists.

Headers
string
required
length between 0 and 36

A unique client-generated identifier for idempotency. Prevents duplicate requests if the same ID is used more than once.

uuid
required

Main account ID.

string
required

SHA-256 signature of the JSON payload and private key. See API Key Authentication

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 3 months ago

Did this page help you?