Create user verification process with our API REST endpoints
\nOur API is a REST API.
\nWe use JSON for all request and response bodies.
\nRate limit applied to all inbound requests. (Soon, the details will be provided)
\nWhen calling VerifySpeed endpoints and facing HTTP errors, the following HTTP response codes may be returned based on errors during request processing:
\n400: Missing or invalid input data.
\n401: Authentication failure.
\nserver-key in the HTTP request.403: Authorization failure.
\n404: Resource not found.
\nFor non-success HTTP responses (e. g., status codes outside 200-299), the response body follows the format defined by RFC 9457.
\nWhen the provided server key is invalid
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7235#section-3.1\",\n \"title\": \"Application not found\",\n \"status\": 401,\n \"errors\": {\n \"server-key\": [\n \"Invalid key\"\n ]\n }\n}\n\nCheck out these documentation pages to get a full understanding of the verification process
\nYour server-side API key is used to authenticate the request. Can be obtained at Dashboard
\n","type":"text"},{"key":"client-ipv4-address","value":"0.0.0.0","description":"The IPv4 address of the client initiating the verification request.
\n","type":"text"}],"url":"https://api.verifyspeed.com/v1/verifications/initialize","description":"This endpoint initializes a phone number verification session. It is the first step in the VerifySpeed verification flow — call this endpoint to begin the process before proceeding to subsequent verification steps. Response contains the list of available verification methods for the client. (See Verification Methods for more details)
\nNote: This step can be done from the client side by initializing with SDKs using the client key
\n","urlObject":{"protocol":"https","path":["v1","verifications","initialize"],"host":["api","verifyspeed","com"],"query":[],"variable":[]}},"response":[{"id":"8dd90236-63d7-437a-9c66-f7d542a24014","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"server-key","value":"sk_UNREALKEY","description":"Your server-side API key is used to authenticate the request. Can be obtained at Dashboard"},{"key":"client-ipv4-address","value":"0.0.0.0","description":"The IPv4 address of the client initiating the verification request."}],"url":"https://api.verifyspeed.com/v1/verifications/initialize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"availableMethods\": [\r\n {\r\n \"methodName\": \"whatsapp-message\",\r\n \"displayName\": \"WhatsAppMessage\"\r\n },\r\n {\r\n \"methodName\": \"sms-otp\",\r\n \"displayName\": \"SmsOtp\"\r\n }\r\n ]\r\n}"}],"_postman_id":"d72ce42f-f6f6-478d-b8f8-07b5e7b7d335"},{"name":"Create Verification","id":"b64678ee-4887-4193-acf3-c37569863236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"server-key","value":"sk_UNREALKEY","description":"Your server-side API key is used to authenticate the request. Can be obtained at Dashboard
\n","type":"text"},{"key":"client-ipv4-address","value":"0.0.0.0","description":"The IPv4 address of the client initiating the verification request.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"methodName\": \"whatsapp-message\",\r\n \"language\": \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyspeed.com/v1/verifications/create","description":"Notes:
\nThe request field language is optional
phoneNumber field is required for OTP methods (whatsapp-otp, telegram-otp, or sms-otp)
Supported languages for now:
\nen for English (Default)
ar for Arabic
ckb for Central Kurdish
Deep-link (deeplink field) in the response is nullable. It is a URL to complete verification on the client side. It is not null if methodName is whatsapp-messege or telegram-message.
Your server-side API key is used to authenticate the request. Can be obtained at Dashboard
\n","type":"text"},{"key":"token","value":"somerandometext","description":"The verification token received from the client
\n","type":"text"}],"url":"https://api.verifyspeed.com/v1/verifications/result","description":"Upon receiving the verification token from the client, you can use the verification result endpoint to decrypt the token and retrieve the user’s verified phone number.
\nThe firstTimeVerified field will be true the first time you fetch the verification result, and false on any subsequent calls. This allows you to determine whether the verification token has been submitted to your backend more than once, which can be useful for security purposes.
Recommended Approach: Client-side Token Decryption
\nInstead of calling the verification result endpoint, we recommend that your server decrypt the verification token directly using your server key. This approach is more efficient and faster, and it eliminates the need for an additional API call.
\nFor detailed implementation examples, see Verification Result Documentation
\n","urlObject":{"protocol":"https","path":["v1","verifications","result"],"host":["api","verifyspeed","com"],"query":[],"variable":[]}},"response":[{"id":"d5d1c6d1-cfa7-4603-a2e3-dbc69f789d3f","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"server-key","value":"sk_UNREALKEY","description":"Your server-side API key is used to authenticate the request. Can be obtained at Dashboard"},{"key":"token","value":"somerandometext","description":"The verification token received from the client"}],"url":"https://api.verifyspeed.com/v1/verifications/initialize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"methodName\": \"telegram-otp\",\r\n \"verificationKey\": \"GG3DCJGTXXNABE5JA3IGRIMOBFMXP7C7ZIGNBCCFFGW1WTI2JL33PUXFAY2OW115\",\r\n \"dateOfVerification\": \"2024-06-24T14:51:02.877Z\",\r\n \"phoneNumber\": \"+12223334455\",\r\n \"firstTimeVerified\": true\r\n}"}],"_postman_id":"eab0e8c8-bfe0-4bdc-8d48-314e3726617b"}]}