{"_id":"5613de7c443514170060dbb6","category":{"_id":"5624bbb785a31117001c5403","pages":["5653264657978b1700df716a","5655bcf8dd82540d00278c26","5655bfd81a06b61900c66873","5655c7c0a66be71700968dd7","5660588e4320a80d00bec124","56618ad455e4450d00e62b89","56f1685a2a85600e00ea3dca"],"project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":7,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-19T09:45:27.364Z","from_sync":false,"order":10,"slug":"2-factor-authentication","title":"2-factor authentication"},"parentDoc":null,"project":"54eb50e5615ffc1900305a16","user":"54eb4fdedf7add210007b29b","editedParams2":true,"__v":0,"editedParams":true,"version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":27,"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","589b19b4fec2730f0082e040","58b04a023529383900a759b5","58b92d1598157a0f004869bf","592e7685c58275000f20174f","59392839e376d4002f8a0474","59393064e376d4002f8a05a1","5947ae0d4005e2000f3a4fec","594a74df1d1de5001ab3517a","5954bc387a147f001b918915"],"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-06T14:45:16.354Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"POST /2fa/1/pin/9C817C6F8AF3D48F9FE553282AFA2B67/verify HTTP/1.1\nHost: api.infobip.com\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\nContent-Type: application/json\n\n{\n  \"pin\":\"1598\"\n}","name":""}]},"method":"post","results":{"codes":[{"code":"{\n  \"pinId\": \"9C817C6F8AF3D48F9FE553282AFA2B67\",\n  \"msisdn\": \"41793026727\",\n  \"verified\": true,\n  \"attemptsRemaining\": 0\n}","name":"Correct PIN","status":200,"language":"json"},{"language":"json","name":"Wrong PIN","status":200,"code":"{\n  \"pinId\": \"9C817C6F8AF3D48F9FE553282AFA2B67\",\n  \"msisdn\": \"41793026727\",\n  \"verified\": false,\n  \"attemptsRemaining\": 2,\n  \"pinError\": \"WRONG_PIN\"\n}"}]},"settings":"554860d6d2c8410d006c215e","auth":"required","params":[{"_id":"5613cdbeecbebc21003fa17b","ref":"","in":"path","required":true,"desc":"ID of the PIN code that has to be verified.","default":"","type":"string","name":"pinId"},{"_id":"5613de7c443514170060dbb7","ref":"","in":"body","required":true,"desc":"PIN code received by user.","default":"","type":"string","name":"pin"}],"url":"/2fa/:version/pin/:pinId/verify"},"isReference":true,"order":11,"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\n## Verify PIN response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*pinId*|String|Sent PIN code ID.|\n|*msisdn*|String|Phone number (msisdn) to which 2FA message was sent.|\n|*verified*|Boolean|Indicates if the phone number (msisdn) was successfully verified.|\n|*attemptsRemaining*|Integer|Number of remaining PIN attempts.|\n|*pinError*|String|Indicates if any error occurs during PIN verification. <br>PIN error can have one of the following values: <br>`WRONG_PIN`<br>`TTL_EXPIRED`<br>`NO_MORE_PIN_ATTEMPTS`|","excerpt":"This method allows you to verify received PIN.","slug":"pin-verify","type":"endpoint","title":"PIN: Verify"}

postPIN: Verify

This method allows you to verify received PIN.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

pinId:
required
string
ID of the PIN code that has to be verified.

Body Params

pin:
required
string
PIN code received by user.

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. ## Verify PIN response |Parameter|Type|Description| |-|-|-| |*pinId*|String|Sent PIN code ID.| |*msisdn*|String|Phone number (msisdn) to which 2FA message was sent.| |*verified*|Boolean|Indicates if the phone number (msisdn) was successfully verified.| |*attemptsRemaining*|Integer|Number of remaining PIN attempts.| |*pinError*|String|Indicates if any error occurs during PIN verification. <br>PIN error can have one of the following values: <br>`WRONG_PIN`<br>`TTL_EXPIRED`<br>`NO_MORE_PIN_ATTEMPTS`|