API Reference

Execute KYC

post
https://example.com/programs//accounts//users//kycGates/kyc2

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

Path Params
string
required

Partner program code for the account.

string
required

Unique account identifier (UID or GUID).

string
required

Unique user identifier (UID or GUID).

Body Params

Encrypted KYC request. See Gd.Bos.DataTransfer.Request.FraudKycCureRequest for required fields.

string | null

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

string | null

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

encryptedUserData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

fraudData
object | null

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

contactVerificationIdentifiers
array of strings | null

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

contactVerificationIdentifiers
string | null

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

Headers
string
required

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

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago