Create KYC Request

post

https://example.com/programs/{programCode}/users/{userIdentifier}/kycGates/kyc2

Creates a KYC2 gate request for a user, submitting SSN for verification. Returns pending KYC gate, status, and attempts remaining.

Path Params

userIdentifier

string

required

The unique identifier of the user whose KYC2 request is being created.

programCode

string

required

The unique code identifying the partner program context.

Body Params

The Gd.Bos.DataTransfer.Request.CreateKyc2Request object containing user information and SSN.

Represents a request to create a KYC2 gate for a user.
Used to submit SSN for KYC2 verification, supporting both plain and encrypted SSN for secure transmission.
Includes a user identifier for internal correlation and tracking.

ssn

string | null

The full SSN of the user.
Used for identity verification in KYC2 flows.

encryptedSsn

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.

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

201Created

403Forbidden

500Internal Server Error

503Service Unavailable