Send OTP

introduction welcome to the api documentation for our versatile otp (one time password) service! our api is designed to facilitate the seamless and secure delivery of otps, supporting customizable options for otp length and text customization with the ability to generate 4, 5, 6, 7 or 8 digit otps, our service caters to a wide range of security requirements what sets our otp api apart is the flexibility it offers in tailoring the otp messages to suit your specific needs you can personalize the text content of otps, making it perfect for branding, localization, or any other contextual requirements additionally, we provide the capability for individual clients to have unique text customizations, ensuring a personalized experience for their end users once the otp is generated & sent to user using send otp docid\ pn8jmab5qffspzkwpclzq api, you can use verify otp docid 3vrirj86eolys6hk2mxb8 api to verify the otp in this documentation, you will find comprehensive information on how to integrate and utilize our api effectively whether you are looking to enhance the security of your applications or seeking to offer a more personalized user experience, our otp service is here to meet your requirements let's dive in and explore the full potential of our customizable otp api! supported regions 200+ countries please find a list below requirements start the process by capturing the phone number from the consumer so you can generate the one time password for that specific number this is generally done via a web form or otherwise obtained via your consumer records please find an example of end user form below after obtaining the phone number, your web server should then initiate a request to the send otp api endpoint as part of the request, the mobilenumber & other required parameters should be included the otp will be sent via sms to the consumer into an sms body as visible in the screenshot below api details sample curl curl location 'https //api signzy us/api/v3/otp verification/send otp' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data '{ "clientid" "64c1115454eb66846d026abf", "phonenumber" "+1 99xxxxxxx1", "channel" "smsotp", "customtextid" "6" }'curl location 'https //api preproduction signzy us/api/v3/otp verification/send otp' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data '{ "clientid" "64c1115454eb66846d026abf", "phonenumber" "+1 99xxxxxxx1", "channel" "smsotp", "customtextid" "6" }' request body parameters parameter name data type required description clientid string yes a unique identifier for the client please contact sales administrator to get a unique clientid assigned to you phonenumber string yes the phone number where the otp will be sent it should be in e 164 format with the country code (e g , +1 for the us) the phone number should be formatted with a "+" sign followed by the country code, a hyphen " ", and then the remaining digits of the phone number for example, "+1 9907676111" for the us channel string yes the preferred channel for sending the otp currently supported values include "smsotp" for sms delivery customtextid string yes an identifier for customizing the otp message the default custom text templates for different otp lengths are pre defined as follows "4" "your otp for verification is ####" "5" "your otp for verification is #####" "6" "your otp for verification is ######" "7" "your otp for verification is #######" "8" "your otp for verification is ########" you need to pass either "4", "5", "6", "7" or "8" to use signzy's default templates customizations in texts are possible you also have option to set your own cutomization in text messages you will need to contact your sales administrator to set it up for e g we can have custom texts like below with diferent custom text ids "41" "signzy \ your otp for login is ####" "51" "signzy \ your otp for authentication is #####" "61" "signzy \ your otp is ######" sample success response otp sent { "result" { "status" 200, "statusdescription" "success otp sent" } } success response parameters parameter name data type description result object an object containing the api response result status integer the http status code of the response result statusdescription string a description of the status of the response supported countries country name country abbreviation supported country codes (append + in starting) supported mobile number length afghanistan af 93 9 to 10 albania al 355 8 to 9 algeria dz 213 9 to 10 american samoa as 1 10 andorra ad 376 6 to 9 angola ao 244 9 to 10 anguilla ai 1 10 antigua and barbuda ag 1 10 argentina ar 54 10 armenia am 374 8 to 9 aruba aw 297 7 to 8 australia au 61 9 to 10 austria at 43 9 to 13 azerbaijan az 994 9 to 10 bahamas bs 1 10 bahrain bh 973 8 to 9 bangladesh bd 880 10 to 11 barbados bb 1 10 belarus by 375 9 belgium be 32 9 to 10 belize bz 501 7 to 8 benin bj 229 8 to 9 bermuda bm 1 10 bhutan bt 975 8 to 9 bolivia bo 591 8 to 9 bosnia and herzegovina ba 387 8 to 9 botswana bw 267 8 to 9 brazil br 55 10 to 11 british virgin islands vg 1 10 brunei darussalam bn 673 7 to 8 bulgaria bg 359 8 to 9 burkina faso bf 226 8 to 9 burundi bi 257 8 cabo verde cv 238 7 cambodia kh 855 9 to 10 cameroon cm 237 8 to 9 canada ca 1 10 caribbean netherlands bq 599 7 cayman islands ky 1 10 central african republic cf 236 7 chad td 235 7 to 8 chile cl 56 9 to 11 china cn 86 11 cocos (keeling) islands cc 61 9 to 12 colombia co 57 10 to 12 comoros km 269 7 to 8 congo cg 242 9 to 10 democratic republic of congo cd 243 9 to 10 cook islands ck 682 5 to 7 costa rica cr 506 8 to 9 côte d'ivoire ci 225 8 to 10 croatia hr 385 8 to 9 cuba cu 53 8 to 9 cyprus cy 357 8 to 9 czech republic cz 420 9 to 12 denmark dk 45 8 to 12 djibouti dj 253 7 to 8 dominica dm 1 10 dominican republic do 1 10 ecuador ec 593 9 egypt eg 20 10 el salvador sv 503 8 to 9 equatorial guinea gq 240 9 to 10 eritrea er 291 7 estonia ee 372 7 to 8 eswatini (swaziland) sz 268 7 to 8 ethiopia et 251 9 to 10 falkland islands (malvinas) fk 500 5 to 6 faroe islands fo 298 6 fiji fj 679 5 to 7 finland fi 358 9 to 12 france fr 33 9 to 12 french guiana gf 594 9 french polynesia pf 689 6 to 8 gabon ga 241 7 to 9 gambia gm 220 7 georgia ge 995 9 to 10 germany de 49 10 to 12 ghana gh 233 9 to 10 gibraltar gi 350 8 to 9 greece gr 30 9 to 10 greenland gl 299 6 to 8 grenada gd 1 10 guadeloupe gp 590 9 guam gu 1 10 guatemala gt 502 8 to 9 guernsey gg 44 10 to 12 guinea gn 224 8 to 9 guinea bissau gw 245 7 guyana gy 592 7 to 8 haiti ht 509 8 to 9 holy see (vatican city) va 379 10 to 11 honduras hn 504 8 to 9 hong kong hk 852 8 to 9 hungary hu 36 9 to 11 iceland is 354 7 to 9 india in 91 10 to 12 indonesia id 62 9 to 12 iran ir 98 10 to 11 iraq iq 964 10 to 11 ireland ie 353 9 to 10 isle of man im 44 10 to 12 israel il 972 9 to 10 italy it 39 9 to 11 ivory coast (côte d'ivoire) ci 225 8 to 9 jamaica jm 1 10 japan jp 81 10 to 11 jersey je 44 10 to 12 jordan jo 962 9 to 10 kazakhstan kz 7 10 kenya ke 254 9 to 12 kiribati ki 686 5 korea (south) kr 82 9 to 11 kosovo xk 383 8 to 10 kuwait kw 965 8 to 9 laos la 856 8 to 10 latvia lv 371 8 lebanon lb 961 7 to 8 lesotho ls 266 8 liberia lr 231 7 to 8 libya ly 218 9 to 10 liechtenstein li 423 8 to 9 lithuania lt 370 8 to 12 luxembourg lu 352 9 macao mo 853 8 to 9 madagascar mg 261 9 to 10 malawi mw 265 9 to 10 malaysia my 60 9 to 10 maldives mv 960 7 to 8 mali ml 223 8 to 9 malta mt 356 8 to 9 marshall islands mh 692 7 martinique mq 596 9 mauritania mr 222 8 to 9 mauritius mu 230 7 to 8 mayotte yt 262 9 mexico mx 52 10 to 12 micronesia, federated states of fm 691 7 moldova, republic of md 373 8 to 10 monaco mc 377 8 to 9 mongolia mn 976 8 to 9 montenegro me 382 9 montserrat ms 1 10 morocco ma 212 9 to 10 mozambique mz 258 9 to 10 myanmar (burma) mm 95 9 to 10 namibia na 264 9 nauru nr 674 7 to 8 nepal np 977 10 to 11 netherlands nl 31 9 to 10 new caledonia nc 687 6 new zealand nz 64 9 to 11 nicaragua ni 505 8 to 9 niger ne 227 8 to 9 nigeria ng 234 10 niue nu 683 4 norfolk island nf 6723 6 north macedonia mk 389 8 to 9 northern mariana islands mp 1 10 norway no 47 8 to 12 oman om 968 8 to 9 pakistan pk 92 10 palau pw 680 7 to 8 palestine ps 970 9 panama pa 507 8 to 9 papua new guinea pg 675 9 to 11 paraguay py 595 9 to 10 peru pe 51 9 to 11 philippines ph 63 10 to 12 pitcairn pn 872 4 to 5 poland pl 48 9 to 11 portugal pt 351 9 puerto rico pr 1 10 qatar qa 974 8 to 9 republic of serbia rs 381 8 12 réunion re 262 9 romania ro 40 9 to 10 russian federation ru 7 10 to 11 rwanda rw 250 9 to 10 saint barthélemy bl 590 9 saint kitts and nevis kn 1 10 saint lucia lc 1 10 saint martin (french part) mf 590 9 saint pierre and miquelon pm 508 6 saint vincent and the grenadines vc 1 10 samoa ws 685 5 san marino sm 378 9 sao tome and principe st 239 7 saudi arabia sa 966 9 to 10 senegal sn 221 9 to 10 serbia rs 381 8 to 10 seychelles sc 248 7 sierra leone sl 232 8 to 9 singapore sg 65 8 to 12 sint maarten (dutch part) sx 1 10 slovakia sk 421 9 to 12 slovenia si 386 8 to 9 solomon islands sb 677 5 to 7 somalia so 252 8 to 11 south africa za 27 9 south sudan ss 211 9 spain es 34 9 to 12 sri lanka lk 94 9 to 10 st vincent & grenadines vc 783 7 sudan sd 249 9 to 10 suriname sr 597 7 to 8 svalbard and jan mayen sj 47 8 sweden se 46 7 to 10 switzerland ch 41 9 to 12 syria sy 963 9 to 10 taiwan tw 886 9 to 10 tajikistan tj 992 9 tanzania, united republic of tz 255 9 to 10 thailand th 66 9 to 10 timor leste tl 670 7 to 8 togo tg 228 8 to 9 tokelau tk 690 4 tonga to 676 5 trinidad and tobago tt 1 10 tunisia tn 216 8 to 9 turkey tr 90 10 turkmenistan tm 993 8 turks and caicos islands tc 1 10 tuvalu tv 688 5 uganda ug 256 9 to 10 ukraine ua 380 9 to 12 united arab emirates ae 971 9 united kingdom gb 44 10 to 12 united states us 1 10 uruguay uy 598 8 to 9 uzbekistan uz 998 9 vanuatu vu 678 5 to 7 venezuela ve 58 10 vietnam vn 84 9 to 11 virgin islands (british) vg 1 10 virgin islands (u s ) vi 1 10 wallis and futuna wf 681 6 western sahara eh 212 9 yemen ye 967 9 to 10 zambia zm 260 9 to 10 zimbabwe zw 263 9 to 10 sample error invalid mobile number { "error" { "name" "error", "message" "mobile number is not valid/allowed", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } customer not found { "error" { "name" "error", "message" "customer not found", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } custom text not found { "error" { "name" "error", "message" "custom text does not exist", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } blocked phone number { "error" { "name" "error", "message" "blocked phone number", "status" 404, "reason" "error", "type" "not found", "statuscode" 200 } } upstream down { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "conflict", "statuscode" 409 } } unprocessable entity { "error" { "name" "error", "message" "unprocessable entity", "status" 422, "reason" "error", "type" "unprocessable entity", "statuscode" 422 } } unauthorized (401) { "message" "no api key found in request" } error response parameters parameter name data type description error object an object containing details about the error error name string the name of the error error message string a descriptive error message error status number the http status code of the client request error reason string the reason for the error error type string the type of error (e g , "bad request") error statuscode number the specific status code returned by the server in response to the request, indicating whether the server was able to process the request and provide a response getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at help\@signzy com we strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively we value your feedback and are committed to making your experience smooth and enjoyable our team is dedicated to assisting you with any needs you may have thank you for choosing our services we look forward to helping you!