Skip to content
API Documentation

sendSMSVerificationCode

Mutation

Send SMS verification code to customer for Spinwheel user verification/consent (step 1 of 2). Customer consent is required to pull Spinwheel credit report.

Mutation Signature

mutation {
  sendSMSVerificationCode(input: SMSVerificationInput!): SMSVerificationResponse!
}

Example Request

mutation SendSMSVerificationCode($input: SMSVerificationInput!) {
  sendSMSVerificationCode(input: $input) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "input": {
    "phoneNumber": "+12135551234",
    "dateOfBirth": "1985-03-15",
    "reqOrgContactId": "contact-12345"
  }
}

Example Response

{
  "data": {
    "sendSMSVerificationCode": {
      "data": {
        "message": "Verification code sent successfully"
      },
      "errors": null
    }
  }
}

Arguments

ArgumentTypeDescription
inputSMSVerificationInput!Input containing phone number and customer details for SMS verification

Input Types

SMSVerificationInput

Input for Spinwheel SMS Verification

Required Fields:

FieldTypeDescription
phoneNumberString!phone number in E.164 format +11231231234
dateOfBirthString!dob in yyyy-mm-dd format 1990-04-12
reqOrgContactIdString!Reqesting organization contact ID

Response Type

Returns: SMSVerificationResponse!

SMSVerificationResponse

SMS Verification 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