{"openapi":"3.0.0","info":{"title":"Silent Verify API","version":"1.0","description":"Use the Telesign Silent Verify API to verify an end user via mobile device data associated with their device, without any additional action by the end user.","contact":{"name":"Telesign Customer Support Team","email":"support@telesign.com"}},"paths":{"/silent/initiate":{"post":{"responses":{"200":{"description":"**Success.** Verification flow initiated.\n\nCode|Description\n--|--\n4501|Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"verification":{"type":"object","description":"Contains properties to pass to the client, instructing them on how to make their request directly to the carrier.","properties":{"verification_url":{"type":"string","example":"https://verification-url.hei-partner.com","description":"A URL for the carrier that you should pass to the client. The client will then hit this URL directly."},"method":{"type":"string","example":"POST","description":"The HTTP method to pass to the client, for them to use when making their call to the carrier."},"expected_response_code":{"type":"integer","example":200,"description":"An HTTP status code to pass to the client, which they should expect in a successful response after making their call to the carrier."},"post_body":{"type":"object","description":"A schema to pass to the client, for them to use in the request body when they make their call directly to the carrier. If no request body is needed, this value is `null`.","nullable":true},"query_string_params":{"type":"object","description":"Contains an object to pass to the client, which contains properties and values for each query param that the client should include in the request they make directly to the carrier. If no query parameters are needed, this value is null.","properties":{"{param1_name}":{"type":"string","example":"param1 value","description":"The first query param and its value. "}},"nullable":true}}}}},{"$ref":"#/components/schemas/SVResponse"}]},"examples":{"Response":{"value":{"verification_url":"https://verification-url.hei-partner.com","method":"POST","expected_response_code":200,"post_body":{"phone_number":"15558675309","external_id":"34g62234"},"query_string_params":{"cache_buster":"53g350"},"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":200,"description":"Success","updated_on":"2020-08-27T17:28:49.559307"}}}}}}},"400":{"description":"**Bad Request**\n\nCode | Description\n--|--\n10004|Bad request\n11000|Invalid value for parameter phone_number\n40003|No end client data found on records\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10001,"description":"field required","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"401":{"description":"**Unauthorized**\n\nCode | Description\n--|--\n40002|Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":40002,"description":"Not authorized","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"408":{"description":"**Request Timeout**\n\nCode | Description\n--|--\n40001 | Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10010,"description":"Request timeout","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"429":{"description":"**Too Many Requests**\n\nCode | Description\n--|--\n10019|Rate limit exceeded\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10019,"description":"Rate limit exceeded","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"500":{"description":"**Internal Server Error**\n\nCode | Description\n--|--\n10039\t|Internal Server Error\n45010   |Provider not found to route the request. This is a permanent error probably due to configuration issues. \n","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10039,"description":"Internal Server Error","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"503":{"description":"**Service Unavailable**\n\nCode | Description\n--|--\n10000 | System unavailable, please try again later\n45005 |Error on gateway - temporary error\n45006 |Error on gateway - permanent error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":4505,"description":"Error on gateway - temporary error","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}}},"operationId":"createSilentVerifyRequest","summary":"Create verification request","parameters":[{"in":"header","name":"Content-Type - json","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string","example":"15558675309","description":"The phone number for the user you want to verify, as digits without spaces or special characters, beginning with the country dialing code."},"external_id":{"type":"string","description":"Your unique identifier for this request. The response simply echoes the value provided for this parameter.","example":"34g62234"}},"required":["phone_number"]}}},"x-examples":{"application/json":{"phone_number":"15558675309","external_id":"34g62234"}}},"description":"Use this action to initiate silent verification of a user via the Telesign Silent Verify API.\n\n**Note:** Before using the sample code on this page, contact the [Telesign Customer Support Team](mailto:support@telesign.com). We will walk you through the necessary onboarding steps before you use the service. This product is for full-service accounts only. **Your request must come from a device with a mobile carrier connection.**\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Encoding:** Accepts only **UTF-8 unicode** characters as inputs.\n* **Accepts:** `application/json`\n* **Responds with:** `application/json`\n* **Rate limit:** [Default rate limits by product](https://support.telesign.com/s/article/do-you-have-any-rate-limits)\n","tags":["Initiate"]},"parameters":[]},"/silent/finalize":{"post":{"responses":{"200":{"description":"**Success.** The service processed your request.\n\n|Code|Description|\n|--|--|\n|4501|Successfully verified|\n|4502|The phone number does not match|","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"Response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":2401,"description":"Success","updated_on":"2020-08-27T17:28:49.559307"}}}}}}},"400":{"description":"**Bad Request**\n\nCode | Description\n--|--\n10004|Bad request \n40003|No end client data found on records\n40004|The required parameter ‘verification’ is missing from the request\n40010|Not in coverage. The phone number being verified is not within the provider's network.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10001,"description":"field required","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"401":{"description":"**Unauthorized**\n\nCode | Description\n--|--\n40002|Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":40002,"description":"Not authorized","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"404":{"description":"**Not Found**\n\nCode | Description\n--|--\n10011|Invalid value for parameter reference_id\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10011,"description":"Invalid value for parameter reference_id","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"408":{"description":"**Request Timeout**\n\nCode | Description\n--|--\n40001 | Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10010,"description":"Request timeout","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"429":{"description":"**Too Many Requests**\n\nCode | Description\n--|--\n10019|Rate limit exceeded\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10019,"description":"Rate limit exceeded","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"500":{"description":"**Internal Server Error**\n\nCode | Description\n--|--\n10039\t|Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":10039,"description":"Internal Server Error","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}},"503":{"description":"**Service Unavailable**\n\nCode | Description\n--|--\n10000 |System unavailable, please try again later\n45005 |Error on gateway - temporary error\n45006 |Error on gateway - permanent error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SVResponse"},"examples":{"response":{"value":{"reference_id":"630d7b76-fee1-4036-9c87-411af82af44c","status":{"code":4505,"description":"Error on gateway - temporary error","updated_on":"2020-08-27T17:28:49.559307Z"}}}}}}}},"operationId":"getSilentVerifyStatus","summary":"Get final verification status","parameters":[{"in":"header","name":"Content-Type - json","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"initiate_reference_id":{"type":"string","description":"The reference ID Telesign returned to you in response to your previous call to initiate verification.","example":"630d7b76-fee1-4036-9c87-411af82af44c"},"verification":{"type":"object","description":"The request payload sent to you from the CLIENT. Include this object exactly as-is."}},"required":["initiate_reference_id","verification"]}}},"x-examples":{"application/json":{"initiate_reference_id":"630d7b76-fee1-4036-9c87-411af82af44c"}}},"description":"Use this action to check for final verification status, after the client receives a response from the carrier.\n\n**Note:** Before using the sample code on this page, contact the [Telesign Customer Support Team](mailto:support@telesign.com). We will walk you through the necessary onboarding steps before you use the service. This product is for full-service accounts only. **Your request must come from a device with a mobile carrier connection.**\n\n## General requirements\n* **Authentication:** [Basic](/enterprise/docs/authentication#basic-authentication) (easiest to implement) or [Digest](/enterprise/docs/authentication#digest-authentication)\n* **Encoding:** Accepts only **UTF-8 unicode** characters as inputs.\n* **Accepts:** `application/json`\n* **Responds with:** `application/json`\n* **Rate limit:** [Default rate limits by product](https://support.telesign.com/s/article/do-you-have-any-rate-limits)","tags":["Finalize"]},"parameters":[]}},"security":[{"Basic":[]}],"servers":[{"url":"https://verify.telesign.com"}],"components":{"securitySchemes":{"Basic":{"type":"http","description":"See [Basic Authentication](/api-reference/authentication#basic-authentication) for more details.","scheme":"basic"}},"schemas":{"SVResponse":{"title":"SVResponse","type":"object","properties":{"reference_id":{"type":"string","description":"A unique, randomly generated hex value that identifies your web service request.","example":"0123456789ABCDEF0123456789ABCDEF"},"status":{"$ref":"#/components/schemas/SVStatus"}}},"SVStatus":{"type":"object","title":"SVStatus","properties":{"code":{"type":"integer","description":"A numeric code that indicates the status of your transaction."},"description":{"type":"string","description":"Text describing the status of your transaction."},"updated_on":{"type":"string","description":"A timestamp showing when your transaction status was updated last.","example":"2020-08-27T17:28:49.559307Z"}}}}},"x-readme":{"explorer-enabled":false,"proxy-enabled":true,"samples-enabled":true},"tags":[{"name":"Finalize"},{"name":"Initiate"}]}