Add KYC1 Request – Creates a KYC1 gate request for a user.

post

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

Creates a KYC1 gate request for a user, submitting SSN suffix for verification. Returns pending KYC gate and status.

Path Params

userIdentifier

string

required

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

programCode

string

required

The unique code identifying the partner program context.

Body Params

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

ssnSuffix

string | null

The last four digits of the user's SSN.

encryptedSsnSuffix

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:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

201Created

403Forbidden

500Internal Server Error

503Service Unavailable