Activate Consumer Bank Account
Header Parameters
Required client-generated UUID v4 used to deduplicate retried mutating requests (POST, PUT, PATCH, DELETE). Requests without this header are rejected with 400 Bad Request. The first successful (2xx) response is cached for 24h and replays of the same key return the cached response without re-executing the operation.
Optional correlation ID associated with the request for tracing and log aggregation.
Path Parameters
The unique identifier (UUID) of the bank account to activate
Body Parameters
The unique identifier (UUID) of the consumer who owns the bank account
The intended use of the bank account. Determines how the account will be utilized within the system.
The micro-deposit amount in cents that was sent to the consumer's bank account for verification. Must be a positive integer.
Response
Bank account successfully activated or already active (idempotent)
Response Attributes
The unique identifier (UUID) of the consumer who owns the bank account
The intended use of the bank account
The current validation status of the bank account. ACTIVE indicates successful activation, PENDING indicates awaiting validation, INACTIVE indicates locked after failed attempts.
The timestamp when the bank account was activated, in ISO 8601 format (UTC timezone). Only present when validation_status is ACTIVE.
The number of remaining activation attempts before the account is locked. Maximum of 2 failed attempts are allowed.
Optional informational message providing additional context about the activation result
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found – Employee record does not exist.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Conflict – Returned for duplicate-record conflicts and optimistic concurrency version mismatches. See duplicate_record and version_conflict examples.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: