Skip to main content
POST
Verify Micro Deposit

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id
string<uuid>
required

Unique identifier (UUID) of the user who owns the bank account being verified.

Body

application/json
account_id
string<uuid>
required

Unique identifier (UUID) of the bank account to initiate verification for.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

verification_amounts
PlatformVerificationAmount · object
required

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data
any | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400