userVerification

Query

Lookup the user verification / consent for a contact. Can be used to determine if a customer has already provided consent to pull the credit report from a specific credit report vendor

Query Signature

query {
  userVerification(reqOrgContactId: String!): UserVerificationResponse
}

Example Request

GraphQL

query UserVerification($reqOrgContactId: String!) {
  userVerification(reqOrgContactId: $reqOrgContactId) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "reqOrgContactId": "contact-12345"
}

Apollo Studio

Open in Apollo Studio Explorer →

Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.

Example Response

{
  "data": {
    "userVerification": {
      "data": {
        "id": "uv-abc123",
        "reqOrgContactId": "contact-12345",
        "creditReportUserId": "cr-user-456",
        "reqOrgId": "org-alleviate",
        "status": "PASSED",
        "verificationDate": "2025-01-15T10:30:00.000Z",
        "userConsentDate": "2025-01-15T10:28:00.000Z",
        "verificationType": "SMS",
        "verificationSource": "SPINWHEEL"
      },
      "errors": null
    }
  }
}

Arguments

Argument	Type	Description
reqOrgContactId	String!	Requesting organization contact ID to lookup verification status

Response Type

Returns: UserVerificationResponse

UserVerificationResponse

User verification lookup response

Field	Type	Description
data	UserVerificationNode	User verification data
errors	[UserVerificationResponseError]	List of error messages

UserVerificationNode

Field	Type	Description
id	ID	user verification ID
reqOrgContactId	String	Requesting Organization Contact ID
creditReportUserId	String	Credit Report User ID
reqOrgId	String	Requesting Organization ID
status	String	Customer verification status. Possible values: - NOT_STARTED: The verification process has not started. - IN_PROGRESS: The verification process is ongoing. - FAILED: The verification process failed…
verificationDate	String	User verification date
userConsentDate	String	User consent date
verificationType	String	Verification type cna be SMS or KBA
verificationSource	String	Verification Source

UserVerificationResponseError

Field	Type	Description
message	String	Error message

Error Types

The response may include the following error types:

UserVerificationResponseError

Field	Type	Description
message	String	Error message

Manual Error Documentation

Add service-specific error codes and their resolutions below.

Common Errors

Error Code	Description	Resolution
VALIDATION_ERROR	Input validation failed	Check required fields and formats
UNAUTHORIZED	Invalid or expired token	Re-authenticate and retry
NOT_FOUND	Resource not found	Verify the ID or reference

Related

• Back to Credit Reporting