---
title: "Add IDV Request – Submits identification verification information for a user."
method: POST
path: "/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/kycGates/idv"
tags: ["Kyc"]
---

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

`POST /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 parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `userIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- CreateIDVRequest — Represents a request to submit identification verification information for a user. Used for IDV validation and account upgrade flows.
  - `idvRequestType` string, nullable — The type of IDV request (e.g., "AccountUpgrade").
  - `encryptedIdentityDocumentation` EncryptedData — 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.
    - `version` string, nullable — The version of the encryption algorithm used to encrypt the data (e.g., "v1", "v2").
    - `ephemeralPublicKey` string, nullable — The ephemeral public key used in the encryption process, typically for key exchange or session establishment.
    - `publicKeyHash` string, nullable — The hash of the public key used to verify the integrity and authenticity of the encryption key.
    - `data` string, nullable — The encrypted data payload, typically base64-encoded, containing the sensitive information.
  - `fraudData` object, nullable — Optional fraud data for additional verification.

## Response `202`

Accepted

- CreateIDVResponse — Represents the response returned after submitting identification verification information. Contains KYC state data.
  - `kycGate` CreateIdv — Represents the response object for an IDV (Identity Verification) operation. Contains the KYC (Know Your Customer) state data, including OFAC screening status, overall KYC status, and any pending KYC gates. Used to communicate the current verification and compliance state for a user after an IDV request.
    - `kycStateData` KycStateData — Represents the Know Your Customer (KYC) state data for a user. Contains information about OFAC (Office of Foreign Assets Control) screening status, overall KYC status, and any pending KYC gates. Used to track regulatory compliance and the current state of user verification during onboarding or account management.
      - `ofacStatus` string, nullable — The OFAC (Office of Foreign Assets Control) screening status for the user. Typical values: "Passed", "Failed", "Pending", or other business-specific status indicators.
      - `kycStatus` string, nullable — The overall KYC (Know Your Customer) status for the user. Typical values: "Verified", "Pending", "Failed", or other business-specific status indicators.
      - `kycPendingGate` string, nullable — The name or code of any pending KYC gate or step that must be completed for full verification. Example: "DocumentVerification", "AddressCheck", or null if no gates are pending.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.dev/greendot/apis/baas-apis.md) · [All operations](https://skmtc.dev/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)