Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Account

Update Account Status and Reason

Structure of API Call: PUT /programs/{programCode}/accounts/{accountIdentifier}/status

  • Update account status and status reason

This endpoint allows Partners to update account statuses, account status reasons, and cures under certain conditions. When a valid request is submitted and completed successfully, the updated status, status reason, and kycPendingGate will be returned in GET /accounts/{accountIdentifier} and GET /enrollments/accounts/{accountIdentifier} responses. An Account Updated Webhook will also be published.

Note: This endpoint can only be used if the Partner is configured to change statuses.

put/programs/{programCode}/accounts/{accountIdentifier}/status

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

Headers

X-GD-RequestIdstring required

Unique request tracking identifier (X-GD-RequestId header).

Request body

reason'unknown' | 'healthy' | 'potentialFraud' | 'spendDown' | 'confirmedFraud' | 'potentialFirstPartyFraud' | 'confirmedFirstPartyFraud' | 'potentialThirdPartyFraud' | 'confirmedThirdPartyFraud' | 'potentialAccountTakeover' | 'confirmedAccountTakeover' | 'potentialIdentityTheft' | 'confirmedIdentityTheft' | 'potentialOtherFraud' | 'confirmedOtherFraud'

The reason for the status change. Specifies the type of fraud, operational, or health reason. See Gd.Bos.DataTransfer.Request.SetPartnerAccountStatusReason for allowed values.

status'unknown' | 'normal' | 'restricted' | 'locked'

The new status to be set for the account. See Gd.Bos.DataTransfer.Request.SetPartnerAccountStatus for allowed values.

notesstring nullable

Required. Notes or comments explaining the reason for the status change.

sourcestring nullable

Optional. The source system or party initiating the status change (e.g., "Partner").

curestring nullable

Optional. The cure or remediation action associated with the status change, if applicable.

Response

OK

statusReasonsstring[] nullable

The list of reasons for the current account status (e.g., compliance, fraud, or operational reasons).

statusstring nullable

The current status or required cure action for the partner account (e.g., "restricted", "normal", "none").

kycPendingGatestring nullable

The name or code of any pending KYC (Know Your Customer) gate, or "none" if no gates are pending.