Pre-Requisites

1. First Orion Branded Communications agreement
2. Access to First Orion Customer Portal
3. Vetted and Approved Business
4. Understanding of First Orion's Authentication Endpoint
5. Tool/Service to invoke API Endpoints (cURL examples shown here)

Where and how to use PROTECT+

This is API is meant to be used in an inbound call flow (IVR). When someone calls into the Call Platform, that phone number would be checked against the PROTECT+ API to assess Risk Level and Category of the inbound number.

Understanding the API Flow.

1. Get the businesses API auth token using the Access Token endpoint.
2. Send inbound calling phone number to the PROTECT+ API endpoint.
3. Assess the results from the API.

Understanding the API call.

This endpoint requires these pieces of information

• In Header: Auth Token
• In Body: aNumber (incoming phone number)

curl --request POST \
     --url https://api.firstorion.com/call-protection/v2 \
     --header 'Authorization: Token String' \
     --header 'content-type: application/json' \
     --data '
{
  "aNumber": "+15017685432"
}
'

{
  "body": {
    "aNumber": "+15017685432",
    "riskLevel": "High",
    "category": "SCAM"
  },
  "error": null
}

Reponse

This will return two areas to base the judgement on: Risk Level and Category.

Risk Levels

• LOW, MEDIUM, HIGH

Categories

• NUISANCE, SCAM, CUSTOMER_SERVICE, DEBT_COLLECTION, INFORMATIONAL, CHARITY, POLITICAL, SURVEY, TELEMARKETING, PRISON