{"__v":6,"_id":"56d41bbed3f4650b007496df","category":{"__v":11,"_id":"5694c4cd1005590d0062cb25","pages":["569f8c611082520d005c703a","569fa534a454d2230002cb72","569fa79197472b1700201634","569fb65c27af53210043231d","569fb6931082520d005c7085","56a0a29cd847b50d00a275f0","56a0ae0ac29eb50d00e33e05","56b9e47cb77e261700bc1425","56bb05b7fb70442b003683ee","56bb06ec959bd90d00afb0a2","56d41bbed3f4650b007496df"],"project":"568fce2a04440a1700e4cb47","version":"568fce2b04440a1700e4cb4a","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-12T09:18:05.741Z","from_sync":false,"order":5,"slug":"rest-services","title":"REST API"},"parentDoc":null,"project":"568fce2a04440a1700e4cb47","user":"55116f88e2990b0d00fb0552","version":{"__v":20,"_id":"568fce2b04440a1700e4cb4a","project":"568fce2a04440a1700e4cb47","createdAt":"2016-01-08T14:56:43.101Z","releaseDate":"2016-01-08T14:56:43.101Z","categories":["568fce2b04440a1700e4cb4b","568fd1b8b700ce0d002f4b1c","568fd23804440a1700e4cb5b","568fd2444719c119002ce5d8","568ff21204440a1700e4cbc1","5693732c8aa8040d009f2c28","5693738393445b0d00abdad0","5693740093445b0d00abdad1","56937445974aaa0d001ca699","5693b82173f48f0d0075c90d","5694c4cd1005590d0062cb25","569f854466a5640d00efa54c","56a264cdd15dd70d008d825b","56aa56bf318e6c1700a19ddb","56b0e6347ae4550d000627bd","56b200c0f48f270d00e0de6f","56b200c6f48f270d00e0de70","56b22a9665ddf50d0076ba40","56e92ef71996862200fd7f42","574d6577fb835c0e00ca316a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-29T10:21:50.888Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"The REST Verify API allows you to easily build phone verification into your application or solution. Typically this used for:\n* Ensuring you have the correct phone number for a user\n* Two factor authentication, either as part of the login process or after login but before performing actions that are considered privileged, e.g. transferring money, closing an account\n* Spam protection, to prevent spammer from automating your user interface and performing bulk operations\n\n##Workflow\nTo verify a phone number\n1. The user supplies their phone number to your application, this may be during registration if you're implementing two factor authentication or at the point of an operation in the form \n2. A 6 digit PIN is sent to the phone via SMS\n3. The user enters the received PIN into your application\n4. If the PIN validations successfully, your application continues with its flow\n\n##Security\nThe Dynmark REST API is offered as HTTPS only to ensure data privacy. We only use TLS 2048 bit encryption. We do not support SSL 2.0 or 3.0.\n\nHTTP requests to the REST API are protected with HTTP Basic authentication using the *Authorization* HTTP header. Your credentials are secure as they are transmitted via HTTPS.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"We recommend specifying a timeout of at least 130 seconds to ensure you always receive a response from our servers. This allows for our internal timeout of 125 seconds plus a 5 second allowance for network and protocol overheads.\"\n}\n[/block]","excerpt":"","slug":"rest-verify-api","type":"basic","title":"REST Verify API"}
The REST Verify API allows you to easily build phone verification into your application or solution. Typically this used for: * Ensuring you have the correct phone number for a user * Two factor authentication, either as part of the login process or after login but before performing actions that are considered privileged, e.g. transferring money, closing an account * Spam protection, to prevent spammer from automating your user interface and performing bulk operations ##Workflow To verify a phone number 1. The user supplies their phone number to your application, this may be during registration if you're implementing two factor authentication or at the point of an operation in the form 2. A 6 digit PIN is sent to the phone via SMS 3. The user enters the received PIN into your application 4. If the PIN validations successfully, your application continues with its flow ##Security The Dynmark REST API is offered as HTTPS only to ensure data privacy. We only use TLS 2048 bit encryption. We do not support SSL 2.0 or 3.0. HTTP requests to the REST API are protected with HTTP Basic authentication using the *Authorization* HTTP header. Your credentials are secure as they are transmitted via HTTPS. [block:callout] { "type": "info", "body": "We recommend specifying a timeout of at least 130 seconds to ensure you always receive a response from our servers. This allows for our internal timeout of 125 seconds plus a 5 second allowance for network and protocol overheads." } [/block]