GRgreendot
ContactVerification

Get Contact Verification Status

Retrieves the contact verification status for a given session identifier and program.

get/programs/{programCode}/verification/status/{sessionIdentifier}

Request

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

Path parameters

programCodestring required

The code of the program for which the contact verification status is retrieved.

sessionIdentifierstring required

The identifier of the contact verification session to retrieve the status for.

Headers

X-GD-RequestIdstring required

The unique request identifier from the request header.

Response

OK

sessionIdentifierstring nullable

The unique identifier for the session associated with the contact verification request.

contactVerificationStatusinteger nullable

The status of the contact verification process. Null if not available.

contactType'phone' | 'email' nullable

The type of contact being verified (e.g., phone, email).

communicationType'sms' | 'email' | 'voiceCall' nullable

The communication method used for verification (e.g., SMS, email, voice call).

Changes

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