Add UC Protect Numbers

UC Protect numbers can be registered via the API to improve real time integration with third party phone number providers.

URL: https://core.purecallerid.app/api/public/ucProtect/add

Method: POST

Content-Type: application/json

Security: A custom HTTP header must be included in the POST request.  The Header name is "X-API-KEY" and the value passed within this header is one of the encrypted API keys associated with your workspace.

Request Body: 

{
  "businessRecordId":"662b924e935778535b11dac4", 
  "numbers": [
    "5555551212",
    "5555551213",
    "5555551214",
    "5555551215"
 ]
}

• businessRecordId: Identifier of the KYC Business Record the phone numbers are associated with. This Identifier can be found in your Pure CallerId dashboard in the Admin --> KYC section.
• numbers: Array of phone numbers to register with the UC Protect service

Response Body: 

{
 "success": [
   {
      "number": "+15555551212,
      "reason": "OK"
   },
   {
      "number": "+1555551213",
      "reason": "OK"
   }
 ],
 "failure": [
   {
      "number": "5555551214",
      "reason": "Invalid phone number"
   },
   {
      "number": "5555551215",
      "reason": "Number already under management"
   }
 ],
 "successfulRecords": 2,
 "failureRecords": 2
}

• success: array  of phone numbers that were successfully registered with UC Protect
• failure: Array of phone numbers that were not able to be registered.  Reason will indicate why the number was not successful
• successRecords: count of newly registered numbers
• failureRecords: count of records that were not able to be registered