Score for Onboarding API - Get Started
Use the TeleSign Score for Onboarding API when an end user creates a new account, to get a risk score and related insights. You can either feed this data into your risk model or decide whether to register the new user based on a risk score threshold.
General Requirements
- Authentication: Basic (use Score for Onboarding Customer ID and API Key)
- Protocols: HTTPS
- Endpoint:
https://detect.telesign.com/intelligence/registrations - Encoding: Accepts only UTF-8 unicode characters as inputs.
- Accepts:
application/json - Responds With:
application/json - Required Headers:
Content-Type - application/json
CAUTION:
Requests to this endpoint authenticate using a different Customer ID and API Key than other TeleSign services. If you don't know your Score for Onboarding authentication credentials, reach out to our Customer Support Team.
Basic Usage
- A user inputs contact data and initiates creation of a new account on your site.
- Your application takes their contact data and any other identity data you have for them (such as IP address) and includes it in a POST /intelligence/registrations request.
- The service responds with a risk score and reason codes. These can be used to power your verification risk model or you can make a decision based directly on the score. See Decision Matrix below.
- If you are satisfied with the evaluation of the user, you can allow the registration to proceed on your site.
Decision Matrix
Although this service returns TeleSign's overall assessment of the risk of a user, you make the final decision about whether to proceed. We recommend creating a decision matrix like the one below, to determine how your integration will process registration attempts.
Example Decision Matrix
| TeleSign Score | TeleSign Risk Level | Your Decision |
|---|---|---|
| 0-80 | low | allow |
| 81-450 | very low | allow |
| 451-500 | medium-low | flag |
| 501-600 | medium | flag |
| 601-800 | high | block |
| 801-1000 | very high | block |
Learn More With Reason Codes
To understand the details of why TeleSign gave the score that it did, look up the reason codes returned on Score API - Insights Reason Code Mappings.
Actions
Get intelligence for a new user registration
POST /intelligence/registrations
Use this action to evaluate the specified end user as part of an onboarding flow, requesting a risk score and related insights.
Updated 15 days ago