Verify

Check SMS Verification Code

Checks whether the <code>code</code> included in the request body matches the most recent, non-expired, not-yet-verified SMS verification code sent to <code>phoneNumber</code> by the specified <code>verificationProfileId</code>.<br/><br/>If <code>code</code> is correct, the endpoint returns a <code>200</code> response with a JSON body that has a <code>params</code> object with <code>status</code> set to <code>verified</code>.<br/><br/>If <code>code</code> is incorrect, the endpoint returns a <code>200</code> response with a JSON body that has a <code>params</code> object with <code>status</code> set to <code>rejected</code>.<br/><br/>If there is no pending verification for <code>phoneNumber</code> because it expired, was already approved, or reached the maximum number of check attempts, the endpoint returns HTTP <code>400</code> with <code>code</code> set to <code>error.verifications.notFound</code> (not HTTP 404).<br/><br/>Call this endpoint only for projects that use Iterable SMS to send SMS messages. If you use your own Twilio or Telnyx account, call their verification endpoints directly.<br/><br/>To use this endpoint, first ask your Iterable customer success manager to add SMS phone verification to your project. To learn more, read <a href="https://support.iterable.com/hc/articles/11559421803796">SMS Phone Verification</a>.

post/api/verify/sms/check

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

codestring required
phoneNumberstring required
verificationProfileIdinteger required

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

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