Generate Contact Verifications

post

https://example.com/programs/{programCode}/contactVerifications

Generates contact verifications for a given program and request. Returns the generated contact verification identifier.

Path Params

programCode

string

required

The code of the program for which verifications are generated.

Body Params

The request payload containing contact verification details.

accountIdentifier

string | null

The unique identifier for the account to be verified.

verificationEventType

string | null

The type of verification event to generate (e.g., registration, password reset).

contactType

string | null

The type of contact to use for verification (e.g., email, phone).

communicationType

string | null

The communication channel to use for verification (e.g., SMS, email).

contactHandle

string | null

The handle or address of the contact (e.g., email address, phone number).

firstName

string | null

The first name of the contact person.

lastName

string | null

The last name of the contact person.

productCode

string | null

The product code associated with the verification request.

retailCardIdentifier

string | null

The retail card identifier, used as a legacy NEC temporary card reference number.

Headers

X-GD-RequestId

string

required

The unique request identifier from the request 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