GRgreendot
Account

Execute KYC

Performs Know Your Customer (KYC) verification for a user on the account. Requires encrypted KYC details in the request body.

post/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/kycGates/kyc2

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

userIdentifierstring required

Unique user identifier (UID or GUID).

Headers

X-GD-RequestIdstring required

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

X-GD-EnrollmentRequestIdentifierstring

Enrollment request identifier (X-GD-EnrollmentRequestIdentifier header).

Request body

accountIdentifierstring nullable

The unique identifier (UID or GUID) of the account for which KYC/fraud cure is being performed.

userIdentifierstring nullable

The unique identifier (UID or GUID) of the user for whom KYC/fraud cure is being performed.

fraudDataobject nullable

Optional. Additional fraud-related data as key-value pairs for further analysis or processing.

contactVerificationIdentifiersstring[] nullable

Optional. A list of contact verification identifiers (e.g., email, phone) used for verifying user contact information.

prospectTypestring nullable

Optional. The type of prospect (e.g., "new", "existing") for the KYC process.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.