Telephony

SMS Verify

Send a unique security code to any mobile device via SMS

post/sms-verify

Request

  • Base URL
    https://neutrinoapi.net
  • Auth
    API key in header user-id and API key in header api-key

Request body application/x-www-form-urlencoded

numberstring required

The phone number to send a verification code to

code-lengthinteger

The number of digits to use in the security code (must be between 4 and 12)

security-codeinteger

Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code

country-codestring

ISO 2-letter country code, assume numbers are based in this country. <br> If not set numbers are assumed to be in international format (with or without the leading + sign)

language-codestring

The language to send the verification code in, available languages are: <ul> <li>de - German</li> <li>en - English</li> <li>es - Spanish</li> <li>fr - French</li> <li>it - Italian</li> <li>pt - Portuguese</li> <li>ru - Russian</li> </ul>

limitinteger

Limit the total number of SMS allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned

limit-ttlinteger

Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)

brand-namestring

Set a custom brand or product name in the verification message

Response

OK

number-validboolean required

True if this a valid phone number

security-codestring required

The security code generated, you can save this code to perform your own verification or you can use the <a href="https://www.neutrinoapi.com/api/verify-security-code/">Verify Security Code API</a>

sentboolean required

True if the SMS has been sent

Changes

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