Add IDV Request – Submits identification verification information for a user.

post

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/kycGates/idv

Submits identification verification information for a user. Supports account upgrade flow and sends PN webhook if cure is none.

Path Params

programCode

string

required

The unique code identifying the partner program context.

accountIdentifier

string

required

The unique identifier of the account associated with the user.

userIdentifier

string

required

The unique identifier of the user whose identity is being verified.

Body Params

The Gd.Bos.DataTransfer.Request.CreateIDVRequest object containing identity verification details.

idvRequestType

string | null

The type of IDV request (e.g., "AccountUpgrade").

encryptedIdentityDocumentation

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 fraud data for additional verification.

Headers

X-GD-RequestId

string

required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

202Accepted

403Forbidden

500Internal Server Error

503Service Unavailable