Numeracle API’s is a reliable and efficient solution for organizations seeking to harness the power of phone number related information.
\nNumeracle employs OAuth 2.0 for authentication. To execute the API, you’ll require a bearer
token. Generate this token using the provided Client ID and secret. Below is an
example of how to create the bearer token.
curl -X POST https://www.sandbox.numeracle.com/oauth/token \\
\n-H \"Content-Type: application/x-www-form-urlencoded\" \\
\n-u : \\<**YOUR_CLIENT_ID**>:<**YOUR_CLIENT_SECRET**>\\
\n-d \"grant_type=client_credentials”
\nRemember to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your actual credentials.
\nNote: The validity of bearer token is around 9 hrs approx. , If you encounter an unauthorized error,please generate a new token with client ID and client secret.
\nhttps://www.sandbox.numeracle.com
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Why Choose Numeracle API's:","slug":"why-choose-numeracle-apis"}],"owner":"46968815","collectionId":"5adba9eb-2ba2-4d0c-8539-3a816c248321","publishedId":"2sB3WjyiGE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-27T16:05:51.000Z"},"item":[{"name":"Change Logs","item":[],"id":"e40d3ddf-0fc9-4277-b076-9dd601d2f074","description":"Change History:
\nMarch, 2026
\nMar, 3:
\nRCD API now requires at least one of Logo or callReason in the request. If both are omitted, the API returns 422 Unprocessable Entity with error code ENTER_RCD_DETAILS.
\nImpacted URLs:
\nV1 : https://www.sandbox.numeracle.com/api/v1/number-profiles/{numberProfileId}/rich-call-data (Method - POST)
\nV0 : https://www.sandbox.numeracle.com/api/numberProfile/rcd (Method - POST)
\nPACE is removed from the list of valid values for industryAssociations field as part of both v0 and v1 versions.
\nImpacted URLs:
\nV1 : https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info (Method - POST)
\nV0 : https://www.sandbox.numeracle.com/api/entityInfo (Method - POST, PUT, VIEW)
\nFebruary, 2026
\nFeb, 3:
\nCDR API has been updated to include two new response fields: claimedSigned and tspName.
\nV1 - CDR Endpoint
\nURL : https://www.sandbox.numeracle.com/api/v1/svip/cdr?lastRecordId=0&limit=10
\nAdded two new fields to the API response:
\nclaimedSigned
tspName
This is applicable for SVIP (BCID) clients
\nCDR API has been updated to include two new response fields: claimedSigned and tspName.
\nV0 - CDR Endpoint
\nAdded two new fields to the API response:
\nclaimedSigned
tspName
This is applicable for SVIP (BCID) clients
\nJanuary, 2026
\nJan, 21:
\nDefault Call Reason: You can now set a default call reason for all your SVIP (BCID) calls. This is in addition to mapping up to 10 call reasons to your campaign.
\nV1 - RCD Endpoint
\nAdded new optional attribute defaultCallReason to specify the default call reason for Rich Call Data profiles.
\nThis is applicable for SVIP (BCID) clients
\nV0 - Add RCD Data Endpoint
\nURL: https://www.sandbox.numeracle.com/api/numberProfile/rcd
\nAdded new optional attribute defaultCallReason to specify the default call reason for Rich Call Data profiles.
\nThis is applicable for SVIP (BCID) clients
\nNumberCheck API
\nV1 - Get Image
\nFix: Removed /batches from the endpoint URL path.
\nBefore: /api/v1/number-check/batches/{batchId}/image/{imageFileName}
\nAfter: /api/v1/number-check/{batchId}/image/{imageFileName}
\nNote: The validity of the bearer token is around 9 hours.
If you encounter an unauthorized error, please generate a new token with the client ID and client secret.
Kindly using the entity v0 and v1 apis based on the below table
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description
\nThis API is used to create a new business entity in the system. The entity can be either a
Root entity (independent) or an Assigned entity (linked to an existing Root entity).
The request must include the entityType, entityName, clientLegalName.
• If the entityType is \"Root\", the rootEntityCode need not be provided (or must be
null).
• If the entityType is \"Assigned\", the rootEntityCode is required and must refer to a
valid Root entity in the system.
Request Parameters:
\nResponse Parameters:
\nInput Validations
\nBusiness Validations
\n","urlObject":{"protocol":"https","path":["api","v1","entity","basic-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"2dbd2248-98a0-49a5-bf06-03a2c48d4597","name":"201-Created-Basic-Root","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerDescription
\nThis API captures the general business information for an existing entity, identified by its unique entityCode. It includes address details, contact numbers, website, and point of contact (POC) information.
This step is usually done after the entity’s basic information has been registered. The API enforces strict validations to ensure the accuracy and completeness of the entity's general info.
\nPath Parameter:
\nResponse Parameters:
\nInput Validation
\nBusiness Validations
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","general-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"a5a3b824-9d8e-4f6a-9156-6143f91d802d","name":"201-Created-General Info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerDescription
\nEntityOfficers is usually a field representing a list of key individuals (e.g., CEO, CFO) responsible for an entity (business, organization, etc.)
\nAllowed Entity Officers Designations:
CEO
CFO
CIO
CTO
President
Other (requires otherDesignation)
Note : Maximum of 5 entityOfficers details can be added.
\nPath Parameter:
\nRequest Parameters:
\nResponse Parameter:
\nInput Validation
\nBusiness Validation
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","entity-officers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"81e79105-28f1-4b3b-8ca3-6445a18b53ad","name":"201-Created-EntityOfficers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerDescription
\nThis endpoint is used to submit billing details and Rich Call Data (RCD) authorizer information for a specified business entity.
\nThe billing section captures full contact and address information required for invoicing and official communication.
\nThe RCD authorizer section identifies the individual responsible for authorizing the use of RCD features (e.g., logos, call reasons, branding metadata) associated with the entity’s phone numbers.
\nNote: Only the root entity will have businessEntityBillingDetails. For assigned entities, exclude this object from the request payload.
\nPath Parameter:
\nRequest Parameters:
\nResponse Parameters:
\nInput Validations - BillingDetails
\nInput Validations - Rcd Authorizer
\nBusiness Validation
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","billing-rcd-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"9088d0ef-c159-48f0-b77a-15ecc59aa1cf","name":"201-Created-Billing-RCD-INFO_Root","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerDescription
\nThis endpoint allows submission of detailed business information for a given entity.
\nIt includes the business’s legal structure, incorporation details, industry classification, and regulatory identifiers (e.g., EIN, DUNS, LEI).
\nPath Parameter:
\nRequest Parameter:
\nResponse Parameter:
\nInput validations for BusinessDetails
\nInput Validation for Registered Agent
\nBusiness Validation
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","business-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"3402a7cd-939f-4132-96be-15bcf3edc572","name":"201-Created-Business-info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerDescription:
\nAdds the communication details for the specified entity, including the business communication type, customer relationship, email addresses, and other contact information used for official correspondence.
\nPath Parameter:
\nRequest Parameter:
\nResponse Parameters:
\nInput Validations
\nBusiness Validations
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","communication-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"64fbebcf-f622-40bc-8fb0-7e9eb622ae8a","name":"201-Created-Communication-info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis endpoint is used to submit the completed entity profile for review, approval, or onboarding. Once all required sections (e.g., general info, officers, business info, communication details) have been completed and validated, this API triggers the formal submission process to move the entity into an approval state.
\nPath Parameter:
\nBusiness Validation
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","submit"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"ed9cd648-8b27-4747-b033-2af729c49d29","name":"200-OK-Submit","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThe Email Notification API lets users set up and control notification preferences for an entity. It allows sending automated alerts (like risk rating updates or health check notifications) to designated email addresses linked to the entity.
\nNotification Types
\n1.Health Check By Brand
2.Health Check By Group
3.Risk Rating Changes
Request Parameters
\nResponse Parameters:
\nInput Validation
\nBusiness Validations
\n","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","email-notification"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"d8b4ba55-7cf4-4a47-b0d7-97b436bac1ca","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerIntroduction:
This suite of REST APIs facilitates a structured and modular approach to onboarding entities into the system. The process is divided into sequential steps, allowing for the incremental collection and submission of all necessary entity information. Each endpoint focuses on a specific aspect of entity data to ensure flexibility, maintainability, and data integrity throughout the onboarding workflow.
Summary of Entity API Endpoints
The API for entity management is structured into a series of endpoints, each dedicated to a specific step of the onboarding process.
1. Add Entity - Basic Info
This endpoint is the initial step, capturing essential identification details such as the entity's name, its type (root or assigned) and legal name.
2. Add Entity - General Info
After the basic info is saved, this endpoint handles additional metadata. It's used to store general details like business address, phone number, and website.
3. Add Entity - Officers
Use this endpoint to register key officers and personnel. It records their roles and contact
information.
4. Add Entity - Billing Details & RCD POC Info
This endpoint is for collecting billing related POC information. It also captures the designated point of contact for approvals (Rich call data POC).
5. Add Entity - Business Details
This endpoint is for gathering all operational and business-specific details, such as EIN, DUNS
number, and state of incorporation.
6. Add Entity - Communication Details
This endpoint collects all communication-related information for the entity. This includes the
business communication type, customer relationship status, consent management, and the types of calls made to name a few.
7. Submit Entity
This is the final step in the process. It validates and submits all the data collected from the previous endpoints for the final approval.
StartFragment
\n8. Config Feature
This endpoint retrieves all features that need to be enabled for the entity, applicable to the root entity.
9. Email Notification
This endpoint enables email notifications for the entity.
Description
\nThis method is used to add a new entity.
\nThis method to retrieve information about an existing entity.
\nThis method is used to update details to an existing entity.
\nThe response body is presented with a status of 200 (OK).
\nThis method is used to delete an entity.
\nThe response body is presented with a status of 200 (OK).
\nList all entities
\nThis method is used to list all entities (Root entities)
\nThis method is used to retrieve all the assigned entities associated with the root entity.
\nThis method is used to add a new document to an entity.
\nAPI method to retrieve the uploaded document as part of Add document API
\nUser will be able to see the file uploaded as an attachment
\nDesignation Table
\nThis API end point is used to create a new number profile and associate numbers to it.
\nCreate number profile contains two sections.
\n1.Number Profile Details.
\n2.Phone Number Details
\nMinimum one phone number must be added, and Maximum limit is 50 numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","number-profiles"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"bdca9cf7-1ee2-48bc-b88d-5f7db49991bb","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThe Update Number Profile feature allows users to make changes to both single and multiple fields within a number profile. This includes modifying profile and phone information like display name, BPO, Contact centre, Procured from, number holder to name a few. In addition, users have the option to perform phone number actions such as adding, editing, or deleting numbers and its attributes such as active status, DNO (Directory Number Option), group name, and type. Users can update anywhere from one to a maximum of 50 phone numbers in a single API call.
\nIn number profile action refers to what kind of operations performed on the phone numbers. Action includes (ADD, EDIT, DELETE). In actions like Edit, while the phone numbers themselves remain unchanged, various attributes associated with them can be updated.
\nPath Parameter:
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Delete Number Profile feature allows users to remove entire number profiles from the system. By utilizing this functionality, users can permanently erase all associated information, including active status, DNO (Directory Number Option), group name, type, and any other details linked to the number profile. This action is irreversible and removes the number profile from the system entirely. It's essential to exercise caution when using this feature to avoid unintentional data loss. Users should ensure they have appropriate authorization and carefully review their actions before proceeding with the deletion of number profiles.
\nIn number profile delete API along with profile details, associated numbers will also get deleted.
\nRequest Body:
\nResponse Body:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The View Number Profile Details feature grants users access to comprehensive information about a specific number profile within the system. Users can examine various attributes and properties. This feature offers users a detailed overview of the number profile, enabling them to understand its characteristics and associated data fully.
\nPath Parameter:
\nResponse Body:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API end point is used to retrieve information about the list of number profiles associated with the given entity code or brand.
\nPath Parameter:
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API end point is used to create a new number profile and associate numbers to it.
\nCreate number profile contains two sections.
\n1.Number Profile Details.
\n2.Phone Number Details
\nMinimum one phone number must be added, and Maximum limit is 200 numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Update Number Profile feature allows users to make changes to both single and multiple fields within a number profile. This includes modifying profile and phone information like display name, BPO, Contact centre, Procured from, number holder to name a few. In addition, users have the option to perform phone number actions such as adding, editing, or deleting numbers and its attributes such as active status, DNO (Directory Number Option), group name, and type. Users can update anywhere from one to a maximum of 50 phone numbers in a single API call.
\nIn number profile action refers to what kind of operations performed on the phone numbers. Action includes (ADD, EDIT, DELETE). In actions like Edit, while the phone numbers themselves remain unchanged, various attributes associated with them can be updated.
\nPath Parameter:
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API endpoint enables you to submit or commit changes made through the Create Number Profile - Save and Update Number Profile - Save actions described in previous sections. Operations such as creating a number profile and adding, editing, or deleting phone numbers will be submitted in bulk when this API is called, initiating the approval and registration process on our end.
\nPath Parameter:
\nResponse Body:
\nBusiness Validation:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API endpoint allows us to add RCD logo and call reason for a profile.
\nPath Parameter:
\nRequest Body:
\nBusiness rule: At least one of logo or callReasons must be provided. If neither is sent (or request is not valid multipart), the API returns an error (see ENTER_RCD_DETAILS below).
\nResponse Body:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","number-profiles","NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","rich-call-data"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"623bb088-59a6-4a50-a147-ea4e960f9709","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API end point is used to retrieve phone number associated to the given relationship.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","number-profiles","NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","phone-numbers","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"1b0de17f-8869-4d2d-907a-fbf1e510ff12","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis method is used to create a new number profile and associate numbers to it. This API will not auto submit the number profile.
\nCreate number profile contains two sections.
\n1.Number Profile Details.
\n2.Phone Number Details
\nMinimum one phone number must be added, and Maximum limit is 200 numbers.
\nThe Update Number Profile feature allows users to make changes to both single and multiple fields within a number profile. This includes modifying profile and phone information like display name, BPO, Contact centre, procured from, number holder to name a few. In addition, users have the option to perform phone number actions such as adding, editing, or deleting numbers and its attributes such as active status, DNO (Directory Number Option), group name, and type. Users can update anywhere from one to a maximum of 200 phonenumbers in a single API call.
\nIn numberprofile action refers to what kind of operations performed on the phone numbers. Action includes (ADD, EDIT, DELETE). In actions like Edit, while the phone numbers themselves remain unchanged, various attributes associated with them can be updated.
\nThis API will not auto submit the number profile.
\nThis API endpoint enables you to submit or commit changes made through the Create Number Profile - Save and Update Number Profile - Save actions described in previous sections. Operations such as creating a number profile and adding,editing, or deleting phone numbers will be submitted in bulk when this API is called, initiating the approval and registration process on our end.
\nThis set of APIs allows you to add up to 200 numbers in a single request. The Create and Update Number Profile APIs can be called multiple times. However, using these endpoints will not automatically submit the profile for approval. A separate Number Profile API is available, which must be called to submit the profile and start the approval process.
\nThese set of API’s can be used as follows
\nScenario: Registering a New Number Profile with 500 Numbers
\nTo create a new profile with 500 numbers and submit them for registration, follow these steps:
\n**Create Number Profile:**Call the Create Number Profile API (/create-profile-save) to initialize the profile and add the first batch of up to 200 numbers.
\n**Update Number Profile:**Use the Update Number Profile - Save API (/update-profile-save) to add the next 200 numbers to the profile by passing the profile id.
\nUpdate Number Profile (Final Batch): Call the Update Number Profile - Save API (/update-profile-save) again to load the remaining 100 numbers into the profile.
\nSubmit Number Profile: Finally, call the Number Profile - Submit API with the profile ID to start
the registration process for the complete profile.
Scenario: Adding 300 numbers to an existing number profile
\nTo update an existing number profile with 300 more (new) numbers and submit them for registration, follow these steps:
\nUpdate Number Profile: Use the Update Number Profile - Save API (/update-profile-save) and add the 200 numbers to theprofile by passing the profile id.
\nUpdate Number Profile (Final Batch): Call the Update Number Profile - Save API (/update-profile-save) again to load the remaining 100 numbers into the profile by passing the profile id.
\nSubmit Number Profile: Finally, call the Number Profile -Submit API with the profile ID to which the numbers were added to start the registration process for the complete profile.
\nNote:
\n-Call “Update Number Profile – Save” more times to add more numbers.
\n-If the “Create Number Profile – Save” and “Update Number Profile – Save” APIs are used to load numbers, these numbers will not be considered for approval until the Submit Number Profile API is
successfully called.
This method is used to create a new number profile and associate numbers to it.
\nCreate number profile contains two sections.
\n1.Number Profile Details.
\n2.Phone Number Details
\nMinimum one phone number must be added, and Maximum limit is 50 numbers.
\nInput Validation
\nBusiness Validations
\n","urlObject":{"protocol":"https","path":["api","number-profile"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"2b402ff6-00b1-4be3-ab71-c648bbd68d99","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThe Update Number Profile feature allows users to make changesto both single and multiple fields within a number profile. This includes modifying profile and phone information like display name, BPO, Contact centre,Procured from, number holder to name a few. In addition, users have the option
to perform phone number actions such as adding, editing, or deleting numbers and its attributes such as active status, DNO (Directory Number Option), groupname, and type. Users can update anywhere from one to a maximum of 50 phone numbers in a single API call.
In number profile action refers to what kind of operations performed on the phone numbers. Action includes (ADD, EDIT, DELETE). In actions like Edit, while the phone numbers themselves remain unchanged, various attributes associated with them can be updated.
\nThe response body is presented with a status of 200 (OK).
\nThe View Number Profile Details feature grants users access to comprehensive information about a
specific number profile within the system. Users can examine various attributes and properties. This feature offers users a detailed overview of the number profile, enabling them to understand its characteristics and associated data fully.
The Delete Number Profile feature allows users to remove entire number profiles from the system. By utilizing this functionality, users can permanently erase all associated information, including active status, DNO (Directory Number Option), group name, type, and any other details linked to
the number profile. This action is irreversible and removes the number profile from the system entirely. It's essential to exercise caution when using this feature to avoid unintentional data loss. Users should ensure they have appropriate authorization and carefully review their actions before proceedingwith the deletion of number profiles.
In number profile delete API along with profile details, associated numbers will also get deleted.
\nThe response body is presented with a status of 200 (OK).
\nThis method is used to submit call reason and logo with numberProfileId
\nRequest body:
\nBusiness rule: At least one of logo or callReasons must be provided. If neither is sent (or request is not valid multipart), the API returns an error (see 'ENTER_RCD_DETAILS' below).
\nResponse parameters:
\nInput Validation
\nBusiness Validations:
\n","urlObject":{"protocol":"https","path":["api","numberProfile","rcd"],"host":["www","sandbox","numeracle","com"],"query":[{"disabled":true,"key":"numberProfileId","value":"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"},{"disabled":true,"key":"entityCode","value":"NUMEXXXXXXXXXX"},{"disabled":true,"key":"callReasons","value":"callReason1"},{"disabled":true,"key":"callReasons","value":"callReason2"},{"disabled":true,"key":"callReasons","value":"callReason3"},{"disabled":true,"key":"defaultCallReason","value":"callReason2"}],"variable":[]}},"response":[{"id":"b2906a5b-3ed1-410e-8cb9-5b421a3f9ae5","name":"200-ok","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API is used to get the phone numbers associated for the given number profile.
\nTo begin the registration process, Number Profiles needs to be
created. The profile helps in grouping the numbers together based on various
parameters. The parameters include brand (to whom the numbers belong or
assigned to), root entity (parent), Calling Party Name / Call display name,
Intent of the call and from where the numbers are procured from including other
parameters.
As part of creating a Number Profile, proceed by associating
phone numbers with it. All properties defined in the Profile will apply to
every number linked to it. To finalize the registration process, ensure at
least one number is associated with the Number Profile. Numbers can be added
individually or in bulk. Number details would include the Telephone numbers, Number
type (Inbound, Outbound or Mixed), Do not originate (Y / N), Active (Y, N and D
– Delete), Number group.
Country Code 1 = United States
\nCountry Code 2 = Canada
\nThis API end point retrieves phone number information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","attributes","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"adf0f21e-bf63-4bf4-8ad1-a63ce875e050","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API end point retrieves rating information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","ratings","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"9539c197-c6c9-4a2c-a0e1-030f55127ccd","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API end point retrieves remediation information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","remediations","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"2eb4a592-b542-43ed-96b7-637d99b36fbb","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API end point retrieves remediation status information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","remediation-status","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"31526717-a16e-4f97-afc6-555e1d80d6dd","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis API end point retrieves phone number fcc information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","fcc-complaints","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"2b6a532d-2c1f-404c-95a6-64089b74c96e","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API endpoint allows us to add an image file. Unique imageID and uploadUrl generated from this API will be used in the request JSON of remediation API. This API endpoint needs to be invoked before calling remediation API.
\nRequest Parameter:
\nRequest Body:
\nResponse Body:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","call-display","image"],"host":["www","sandbox","numeracle","com"],"query":[{"key":"description","value":"Image Description"},{"key":"reason","value":"Image Reason"}],"variable":[]}},"response":[{"id":"9fad552d-02a0-4b95-95ab-d212b37b6526","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis suite of REST APIs facilitates a structured and modular approach to retrieve the risk rating, remediation and fcc data for the given phone number list.
\nView Risk Rating Number Details
\nThis method retrieves the rating information (across carriers) for a single phone number or multiple numbers.
\nView Remediation Number Details
\nThis API end point retrieves remediation information for a single phone number or multiple numbers.
\nView Remediation status Number Details
\nThis API end point retrieves remediation status information for a single phone number or multiple numbers.
\nView FCC Issue Number Details
\nThis API end point is used to retrieve FCC complaints associated with a phone number or multiple numbers.
\nFCC data can be retrieved for last 60 days with respect to ticket created date. Range between start date and end date should not be extend more than 60 days.
\nView Phone Number Details
\nThis API end point is used to retrieve phone number information for a single phone number or multiple numbers.
\nGet Phone Number Details By Relationship Code
\nThis API end point is used to retrieve phone number associated to the given relationship.
\nAdd Image API
\nThis API endpoint allows us to add an image file. Unique imageID and uploadUrl generated from this API will be used in the request JSON of remediation API. This API endpoint needs to be invoked before calling remediation API.
\n","_postman_id":"7addc1d6-e7e3-4f34-aab4-7aa8911246a6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This method retrieves information associated for a single phone number or multiple numbers.
\nThis method retrieves the rating information (across carriers) for a single phone number or multiple numbers.
\nThis method retrieves remediation update information for a single phone number or multiple numbers.
\nThis method retrieves remediation update information for a single phone number or multiple numbers.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","phone-number","remediation-status"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"f647ee3e-9a90-4ab7-99b6-f579e52f78af","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis method is used to retrieve FCC complaints associated with a phone number or multiple numbers.
\nFCC data can be retrieved for last 60 days with respect to ticket created date. Range between start date and end date should not be extend more than 60 days.
\nThis API endpoint allows us to add an image file. Unique imageID and uploadUrl generated from this API will be used in the request JSON of remediation API. This API endpoint needs to be invoked before calling remediation API
\nRating Table (Rating API)
\nHow can you determine if the number registration (cleaning) process is complete?
\nIf the ‘rating’ field in the {{url}}/api/phone-number/rating API shows a value other than Not Rated, the rating process is complete. Possible values include Low, Medium, Spam, and Fraud.
\nWhat do the different values in the rating field represent?
\nNot Rated: The number has not been rated yet and is still being processed.
\nLow: The number is clean.
\nMedium: The number is clean.
\nSpam: The number is flagged as spam.
\nFraud: The number is flagged as fraudulent.
\nDoes Numeracle auto initiate remediation for numbers identified as tagged (Spam, Fraud)?
\nHow can you determine if a remediation request is complete?
\nIf a record exists in the {{url}}/api/phone-number/remediation API with a recent ‘resolvedDate’ and a corresponding value in the ‘result’ field, the remediation request is complete.
\nPossible values for both ‘rating’ and ‘result’ fields are Low, Medium, Spam, and Fraud.
\nHow long does the remediation process typically take?
\nHow often can the ratings and remediation APIs be called?
\nRating API: Can be called weekly on Mondays, with a backup call on Tuesdays if no updates are available (based on riskRatingDate).
\nRemediation API: Ideally called once or twice a week for updates.
\nCan the reason for a failed remediation request be identified via API’s?
\nThis API allows you to create a number check batch with up to 10 phone numbers. The API submits these numbers to retrieve the latest ratings and screenshots, providing a unique submission ID in response. Once the batch is complete, a notification is sent to the specified webhook URL, using the JSON structure outlined in the webhook documentation.
\nRequest Body:
\nResponse Body:
\nInput Validation:
\nBusiness Validation:
\n","urlObject":{"protocol":"https","path":["api","v1","number-check","batches"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"dee1932d-0c73-432e-ad2c-ab9eb1679335","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis API provides comprehensive details of a number check batch, including:
\nBatch Information: Displays the status of the batch (e.g., New, In Review, Done) and identifiers such as root entity code, root entity name, brand name, profile descriptor, profile ID, and the country associated with the phone number.
\nPhone Numbers and File names: Includes a list of file names that include real screenshots for each phone number, categorized by service providers (AT&T, T-Mobile, and Verizon) and it’s associated rating \"Low\", \"Medium\", \"Spam\", \"Fraud\" or \"Not Rated\".
\nPath Parameter:
\n