Skip to main content
Scrive logoeID Hub Documentation

Usage

Create an SMS OTP transaction with provider: smsOtp and method: auth. The phone number is the only required input; everything else has sensible defaults.

Phone number​

Set msisdn in international format, for example +447700900123. The number can alternatively be provided on the transaction start call; if it's supplied in both places they must match, otherwise eID Hub rejects the request.

Sender ID​

Set originator to control what the recipient sees as the sender in their messaging app. Accepted formats are a phone number in international format, a short code (5 or 6 digits), or an alphanumeric string up to 11 characters.

Using your own alphanumeric sender ID is strongly recommended. A recognisable name like MyService signals to the user that the message is legitimate, which reduces friction and the chance it's dismissed as spam. Note that alphanumeric sender IDs are not supported in all countries and some require pre-registration before use. See Link Mobility's sender ID regulatory guidelines for per-country rules.

Message text​

Set messageText to customise the text prepended to the OTP code. Defaults to Your one-time code is — the six-digit code is appended automatically, so there's no need to include a placeholder. Maximum length is 154 characters using GSM-standard characters, or 64 if unicode is needed. URLs are not permitted.

Max attempts​

Set maxNumberOfAttempts to control how many times the user can enter an incorrect code before the transaction fails. Defaults to 5, maximum is 5.

Completion data​

Transaction info includes the phone number the code was sent to and, depending on the recipient's carrier, a delivery flag confirming the SMS was received. See SMS OTP parameters.

Coverage​

Scrive sends SMS OTP codes to mobile numbers in over 80 countries. For some additional countries restrictions apply, typically a pre-registration step to activate the service. Sender ID format support also varies by country. Check Link Mobility's sender ID regulatory guidelines before using an alphanumeric or short-code originator.