{"__v":3,"_id":"5613cdbeecbebc21003fa179","category":{"__v":7,"_id":"5624bbb785a31117001c5403","pages":["5653264657978b1700df716a","5655bcf8dd82540d00278c26","5655bfd81a06b61900c66873","5655c7c0a66be71700968dd7","5660588e4320a80d00bec124","56618ad455e4450d00e62b89","56f1685a2a85600e00ea3dca"],"project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-19T09:45:27.364Z","from_sync":false,"order":8,"slug":"2-factor-authentication","title":"2-factor authentication"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54eb50e5615ffc1900305a16","user":"54eb4fdedf7add210007b29b","version":{"__v":18,"_id":"54eb63b859b1172100334fae","forked_from":"54eb63a1867e1917009b711d","project":"54eb50e5615ffc1900305a16","createdAt":"2015-02-23T17:30:32.501Z","releaseDate":"2015-02-23T17:30:32.501Z","categories":["54eb63b959b1172100334faf","54eb63b959b1172100334fb0","54eb63b959b1172100334fb1","54eb63b959b1172100334fb2","54ed8dd4ab373e2300f50eae","54ed99b2ab373e2300f50ede","55153a6de68daa2f00cff838","551546edbc466623002afe72","5515472ac28d6125001b8884","55154749c28d6125001b8885","555d9b4106dfec0d00d38ea7","5613e06e433e5735007c7708","5624bbb785a31117001c5403","56669e857cc81e0d00253f8e","568b8d837a42220d00498311","56a632277ef6620d00e2f18a","56d8147c3eb4dd0b00201aac","57a9ce2fac6db30e000d7efd","57a9cf4e944ea60e00dc3f74","58172386715dce0f00da4aa0","582dc59ee1b8692300c0dd03"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T13:33:50.553Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"POST /2fa/1/pin?ncNeeded=true HTTP/1.1\nHost: api.infobip.com\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\nContent-Type: application/json\n\n{\n  \"applicationId\": \"HJ675435E3A6EA43432G5F37A635KJ8B\",\n  \"messageId\": \"0130269F44AFD07AEBC2FEFEB30398A0\",\n  \"from\": \"InfoSMS\",\n  \"to\": \"41793026727\"\n}","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"pinId\": \"9C817C6F8AF3D48F9FE553282AFA2B67\",\n  \"to\": \"41793026727\",\n  \"ncStatus\": \"NC_DESTINATION_REACHABLE\",\n  \"smsStatus\": \"MESSAGE_SENT\"\n}","name":""},{"code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"UNAUTHORIZED\",\n      \"text\": \"Invalid login details\"\n    }\n  }\n}","language":"json","status":401}]},"settings":"554860d6d2c8410d006c215e","auth":"required","params":[{"_id":"5613cdbeecbebc21003fa17b","ref":"","in":"body","required":true,"desc":"Phone number to which 2FA message will be sent. Must be in international format (Example: `41793026727`).","default":"","type":"string","name":"to"},{"_id":"5613cdbeecbebc21003fa17d","ref":"","in":"body","required":true,"desc":"2FA application ID.","default":"","type":"string","name":"applicationId"},{"_id":"5613cdbeecbebc21003fa17c","ref":"","in":"body","required":true,"desc":"ID of 2FA message that will be sent to a phone number.","default":"","type":"string","name":"messageId"},{"_id":"5613cdbeecbebc21003fa17a","ref":"","in":"body","required":false,"desc":"Sender ID in numeric or alphanumeric format. If this parameter is not set, it will be automatically filled from the created message parameter sender.","default":"","type":"string","name":"from"},{"_id":"5613d1ba6a092921004c30a9","ref":"","in":"body","required":false,"desc":"Indicates if Number Lookup is needed before sending 2FA message. If the parameter value is `true`, Number Lookup will be requested before sending SMS. If the value is `false`, SMS will be sent without requesting Number Lookup. **Default value is `true`.**","default":"true","type":"boolean","name":"ncNeeded"}],"url":"/2fa/:version/pin"},"isReference":true,"order":9,"body":"## Response format\n\nOn success, response header HTTP status code will be `200 OK`. \n\nOn error, you will receive an [error response status code](doc:2fa-status-codes-and-error-details) in the header and the response body will contain an [error object](doc:2fa-status-codes-and-error-details). If you try to create an application when you do not have the user’s authorization, you will receive an error `401` Unauthorized.\n\nOne of the common messages is **429 Too Many Requests**. Most often the source of this message is a security feature put in place on application level.[ Application: Get](doc:application-get) method offers a quick overview of the current settings. Closer examination of the values should reveal the reasons behind the message. **InitiationAttempts **and **verificationIntervalLength **properties are the usual suspects.\n\n### Response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*to*|String|Phone number to which 2FA message was sent.|\n|*ncStatus*|String|Status of sent Number Lookup. <br>Number Lookup status can have one of the following values: `NC_DESTINATION_UNKNOWN`, `NC_DESTINATION_REACHABLE`, `NC_DESTINATION_NOT_REACHABLE`, `NC_NOT_CONFIGURED`. <br>If you get `NC_NOT_CONFIGURED` status, you should contact your account manager for configuring it. <br>**SMS will not be sent only if Number Lookup status is `NC_NOT_REACHABLE`**.|\n|*smsStatus*|String|Sent SMS status. Can have one of the following values: `MESSAGE_SENT`, `MESSAGE_NOT_SENT`.|\n|*pinId*|String|Sent PIN code ID.|","excerpt":"This method allows you to generate and send a PIN code over SMS to provided destination address.","slug":"pin-send-over-sms","type":"post","title":"PIN: Send over SMS"}

postPIN: Send over SMS

This method allows you to generate and send a PIN code over SMS to provided destination address.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

to:
required
string
Phone number to which 2FA message will be sent. Must be in international format (Example: `41793026727`).
applicationId:
required
string
2FA application ID.
messageId:
required
string
ID of 2FA message that will be sent to a phone number.
from:
string
Sender ID in numeric or alphanumeric format. If this parameter is not set, it will be automatically filled from the created message parameter sender.
ncNeeded:
booleantrue
Indicates if Number Lookup is needed before sending 2FA message. If the parameter value is `true`, Number Lookup will be requested before sending SMS. If the value is `false`, SMS will be sent without requesting Number Lookup. **Default value is `true`.**

Examples


Result Format


Documentation

## Response format On success, response header HTTP status code will be `200 OK`. On error, you will receive an [error response status code](doc:2fa-status-codes-and-error-details) in the header and the response body will contain an [error object](doc:2fa-status-codes-and-error-details). If you try to create an application when you do not have the user’s authorization, you will receive an error `401` Unauthorized. One of the common messages is **429 Too Many Requests**. Most often the source of this message is a security feature put in place on application level.[ Application: Get](doc:application-get) method offers a quick overview of the current settings. Closer examination of the values should reveal the reasons behind the message. **InitiationAttempts **and **verificationIntervalLength **properties are the usual suspects. ### Response |Parameter|Type|Description| |-|-|-| |*to*|String|Phone number to which 2FA message was sent.| |*ncStatus*|String|Status of sent Number Lookup. <br>Number Lookup status can have one of the following values: `NC_DESTINATION_UNKNOWN`, `NC_DESTINATION_REACHABLE`, `NC_DESTINATION_NOT_REACHABLE`, `NC_NOT_CONFIGURED`. <br>If you get `NC_NOT_CONFIGURED` status, you should contact your account manager for configuring it. <br>**SMS will not be sent only if Number Lookup status is `NC_NOT_REACHABLE`**.| |*smsStatus*|String|Sent SMS status. Can have one of the following values: `MESSAGE_SENT`, `MESSAGE_NOT_SENT`.| |*pinId*|String|Sent PIN code ID.|