Skip to content
API Documentation

verifySMSCode

Mutation

Validate Spinwheel verification code sent to customer (step 2 of 2). This will give the requesting organzation consent to pull the Spinwheel credit report.

Mutation Signature

mutation {
  verifySMSCode(input: VerifySMSCodeInput!): VerifySMSCodeResponse!
}

Example Request

mutation VerifySMSCode($input: VerifySMSCodeInput!) {
  verifySMSCode(input: $input) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "input": {
    "reqOrgContactId": "contact-12345",
    "verificationCode": "123456"
  }
}

Example Response

{
  "data": {
    "verifySMSCode": {
      "data": {
        "message": "Verification successful"
      },
      "errors": null
    }
  }
}

Arguments

ArgumentTypeDescription
inputVerifySMSCodeInput!Input containing the verification code to validate

Input Types

VerifySMSCodeInput

Input for Spinwheel SMS Code Verification

Required Fields:

FieldTypeDescription
reqOrgContactIdString!Reqesting organization contact ID
verificationCodeString!Verification code that spinwheel sends via SMS

Response Type

Returns: VerifySMSCodeResponse!

VerifySMSCodeResponse

Verify SMS Code Response

FieldTypeDescription
dataSMSVerificationResultSuccess message
errors[SMSVerificationResponseError]List of error messages

SMSVerificationResult

SMS Verification Result

FieldTypeDescription
messageStringSMS Verification success message

SMSVerificationResponseError

SMS Verification Response Error

FieldTypeDescription
messageStringSMS verification error message

Error Types

The response may include the following error types:

SMSVerificationResponseError

SMS Verification Response Error

FieldTypeDescription
messageStringSMS verification error message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference