GRgreendot
ContactVerification

Generate Contact Verifications

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

post/programs/{programCode}/contactVerifications

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The code of the program for which verifications are generated.

Headers

X-GD-RequestIdstring required

The unique request identifier from the request header.

Request body

accountIdentifierstring nullable

The unique identifier for the account to be verified.

verificationEventTypestring nullable

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

contactTypestring nullable

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

communicationTypestring nullable

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

contactHandlestring nullable

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

firstNamestring nullable

The first name of the contact person.

lastNamestring nullable

The last name of the contact person.

productCodestring nullable

The product code associated with the verification request.

retailCardIdentifierstring nullable

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

Response

Created

contactVerificationIdentifierstring nullable

Gets or sets the unique identifier for the contact verification. Used to track and reference the verification process for a contact.

Changes

No recorded changes to this operation across all 2 revisions of this API.