{"info":{"_postman_id":"c5bd7041-cec4-4844-b802-1b078f0240a1","name":"Numeracle API-V1.0.0 SVIP","description":"<html><head></head><body><h1 id=\"why-choose-numeracle-apis\">Why Choose Numeracle API's:</h1>\n<p>Numeracle API’s is a reliable and efficient solution for organizations seeking to harness the power of phone number related information.</p>\n<h2 id=\"numeracle-authentication\">Numeracle Authentication:</h2>\n<p>Numeracle employs OAuth 2.0 for authentication. To execute the API, you’ll require a bearer<br>token. Generate this token using the provided Client ID and secret. Below is an<br>example of how to create the bearer token.</p>\n<p>curl -X POST <a href=\"https://www.sandbox.numeracle.com/oauth/token\">https://www.sandbox.numeracle.com/oauth/token</a> \\</p>\n<p>-H \"Content-Type: application/x-www-form-urlencoded\" \\</p>\n<p>-u : \\&lt;**YOUR_CLIENT_ID**&gt;:&lt;**YOUR_CLIENT_SECRET**&gt;\\</p>\n<p>-d \"grant_type=client_credentials”</p>\n<p>Remember to replace <strong>YOUR_CLIENT_ID</strong> and <strong>YOUR_CLIENT_SECRET</strong> with your actual credentials.</p>\n<p>Note: 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.</p>\n<h2 id=\"sandbox-environment\">Sandbox Environment</h2>\n<p><a href=\"https://www.sandbox.numeracle.com\">https://www.sandbox.numeracle.com</a></p>\n</body></html>","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":"39598180","collectionId":"c5bd7041-cec4-4844-b802-1b078f0240a1","publishedId":"2sBYHRTgG3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-12T04:01:22.000Z"},"item":[{"name":"oauth","item":[{"name":"token","item":[{"name":"Sandbox Token","id":"e23007fb-2794-4f96-aee7-3c8d17f7e5e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials"}]},"url":"https://www.sandbox.numeracle.com/oauth/token","description":"<p>Note: The validity of the bearer token is around 9 hours.<br />If you encounter an unauthorized error, please generate a new token with the client ID and client secret.</p>\n","urlObject":{"protocol":"https","path":["oauth","token"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"bd5b4168-9723-4c20-a79b-8c04eaab64f2","name":"Sandbox Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials"}]},"url":"https://www.sandbox.numeracle.com/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Oct 2025 10:37:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n    \"access_token\": \"8d94f81f-6cad-4872-9a2e-161321ca9314\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 36055,\n    \"scope\": \"read trust write\"\n}"}],"_postman_id":"e23007fb-2794-4f96-aee7-3c8d17f7e5e4"}],"id":"7d3dc8ee-8dd1-4096-8720-744dab1d490b","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"00014c4d-b4d4-4ba2-a807-5c8d00deb668"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"fd90e11a-3fa3-49ac-aaba-10a22ccda95d"}}],"_postman_id":"7d3dc8ee-8dd1-4096-8720-744dab1d490b","description":""}],"id":"13b5157c-0748-44be-8e74-d3ad0ad3e511","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c43b3c15-3c2a-48d6-be17-2d06a6b0c256"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"82313896-4541-455c-b5c6-73b80e02c0bc"}}],"_postman_id":"13b5157c-0748-44be-8e74-d3ad0ad3e511","description":""},{"name":"SVIP","item":[{"name":"v1","item":[{"name":"Retrieve OSPs","id":"dfa76c7c-811a-476a-ac10-f201467c7f11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/osps?lastRecordId=1&limit=10","description":"<h4 id=\"description\">Description</h4>\n<p>Fetches the list of <strong>Originating Service Providers (OSPs)</strong> currently available.</p>\n<h4 id=\"query-params\"><strong>Query Params</strong></h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Query Parameter</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>lastRecordId</code></td>\n<td>Integer</td>\n<td>Yes</td>\n<td>The number of records to skip before returning results should be defined. The lastRecordId value must always equal the limit from the preous request to ensure continuous, non-overlapping data retrieval.</td>\n</tr>\n<tr>\n<td><code>limit</code></td>\n<td>Integer</td>\n<td>Yes</td>\n<td>limit refers to the maximum count of records to be retrieved per batch, default and max limit is 1000.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"business-validations\">Business Validations</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Custom Error Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>MALFORMED_REQUEST_PARAMETERS</td>\n<td>Malformed request parameters. Check the request parameters.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>LIMIT_COUNT_VALIDATION</td>\n<td>Limit must be less than or equal to 1000.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>CHECK_FOR_LIMIT_MIN</td>\n<td>Limit count must be greater than 0.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>CHECK_FOR_LASTRECORD_ID_MIN</td>\n<td>LastRecordId must be greater than or equal to 0.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time when the response was generated.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Status of the API call (<code>SUCCESS</code> / <code>FAILURE</code>).</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message about the API response.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint path.</td>\n</tr>\n<tr>\n<td><code>data.reords.osps</code></td>\n<td>Array of OSPs</td>\n<td>List of Originating Service Providers (OSPs).</td>\n</tr>\n<tr>\n<td><code>data.reords.lastRecordId</code></td>\n<td>Integer</td>\n<td>ID of the last record returned; used for pagination.</td>\n</tr>\n<tr>\n<td><code>data.reords.hasMoreRecords</code></td>\n<td>Boolean</td>\n<td>Indicates if more records are available for fetching.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","osps"],"host":["www","sandbox","numeracle","com"],"query":[{"key":"lastRecordId","value":"1"},{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"735b5656-38cc-4454-b3ed-6b4ab03d1955","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/svip/osps?lastRecordId=1&limit=10","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","svip","osps"],"query":[{"key":"lastRecordId","value":"1"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T02:41:46:46Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"Originating Service Providers (OSPs) list retrieved successfully.\",\r\n    \"path\": \"api/v1/svip/osps\",\r\n    \"data\": {\r\n        \"reords\": {\r\n            \"osps\": [\r\n                {\r\n                    \"id\": 1,\r\n                    \"ospName\": \"Go2Uno LLC\",\r\n                    \"ospId\": \"go2uno-osp\"\r\n                },\r\n                {\r\n                    \"id\": 2,\r\n                    \"ospName\": \"Twilio\",\r\n                    \"ospId\": \"twilio-osp\"\r\n                },\r\n                {\r\n                    \"id\": 3,\r\n                    \"ospName\": \"Smart Carrier\",\r\n                    \"ospId\": \"smartcarrier-osp\"\r\n                },\r\n                {\r\n                    \"id\": 4,\r\n                    \"ospName\": \"Contact Center Compliance\",\r\n                    \"ospId\": \"contactcentercompliance-osp\"\r\n                },\r\n                {\r\n                    \"id\": 5,\r\n                    \"ospName\": \"Atheral LLC\",\r\n                    \"ospId\": \"atheral-osp\"\r\n                },\r\n                {\r\n                    \"id\": 6,\r\n                    \"ospName\": \"Barcks Corp\",\r\n                    \"ospId\": \"barckscorp-osp\"\r\n                },\r\n                {\r\n                    \"id\": 7,\r\n                    \"ospName\": \"TeleVoIPs\",\r\n                    \"ospId\": \"televoips-osp\"\r\n                },\r\n                {\r\n                    \"id\": 8,\r\n                    \"ospName\": \"Ewart Technologies\",\r\n                    \"ospId\": \"ewarttechnologies-osp\"\r\n                },\r\n                {\r\n                    \"id\": 9,\r\n                    \"ospName\": \"NUSO\",\r\n                    \"ospId\": \"nuso-osp\"\r\n                },\r\n                {\r\n                    \"id\": 10,\r\n                    \"ospName\": \"IPtelX LLC\",\r\n                    \"ospId\": \"iptelx-osp\"\r\n                }\r\n            ],\r\n            \"lastRecordId\": 10,\r\n            \"hasMoreRecords\": true\r\n        }\r\n    }\r\n}"},{"id":"448bd68c-c4f0-45fc-9bfa-818a26bfb422","name":"400-BadRequest","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/svip/osps?lastRecordId=1&limit=10","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","svip","osps"],"query":[{"key":"lastRecordId","value":"1"},{"key":"limit","value":"10"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T02:41:46:46Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"Originating Service Providers (OSPs) list retrieved successfully.\",\r\n    \"path\": \"api/v1/svip/osps\",\r\n    \"data\": {\r\n        \"reords\": {\r\n            \"osps\": [\r\n                {\r\n                    \"id\": 88,\r\n                    \"ospName\": \"Go2Uno LLC\",\r\n                    \"ospId\": \"go2uno-osp\"\r\n                },\r\n                {\r\n                    \"id\": 89,\r\n                    \"ospName\": \"Twilio\",\r\n                    \"ospId\": \"twilio-osp\"\r\n                },\r\n                {\r\n                    \"id\": 90,\r\n                    \"ospName\": \"Smart Carrier\",\r\n                    \"ospId\": \"smartcarrier-osp\"\r\n                },\r\n                {\r\n                    \"id\": 91,\r\n                    \"ospName\": \"Contact Center Compliance\",\r\n                    \"ospId\": \"contactcentercompliance-osp\"\r\n                },\r\n                {\r\n                    \"id\": 92,\r\n                    \"ospName\": \"Atheral LLC\",\r\n                    \"ospId\": \"atheral-osp\"\r\n                },\r\n                {\r\n                    \"id\": 93,\r\n                    \"ospName\": \"Barcks Corp\",\r\n                    \"ospId\": \"barckscorp-osp\"\r\n                },\r\n                {\r\n                    \"id\": 94,\r\n                    \"ospName\": \"TeleVoIPs\",\r\n                    \"ospId\": \"televoips-osp\"\r\n                },\r\n                {\r\n                    \"id\": 95,\r\n                    \"ospName\": \"Ewart Technologies\",\r\n                    \"ospId\": \"ewarttechnologies-osp\"\r\n                },\r\n                {\r\n                    \"id\": 96,\r\n                    \"ospName\": \"NUSO\",\r\n                    \"ospId\": \"nuso-osp\"\r\n                },\r\n                {\r\n                    \"id\": 97,\r\n                    \"ospName\": \"IPtelX LLC\",\r\n                    \"ospId\": \"iptelx-osp\"\r\n                }\r\n            ],\r\n            \"lastRecordId\": 97,\r\n            \"hasMoreRecords\": true\r\n        }\r\n    }\r\n}"}],"_postman_id":"dfa76c7c-811a-476a-ac10-f201467c7f11"},{"name":"Update OSPs","id":"7bae044f-9b60-4aa2-b672-3683533696b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"action\": \"ADD\",\r\n  \"originatingServiceProviders\": [\r\n    \"Twilio\",\r\n    \"Barcks Corp\"\r\n  ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX/osps","description":"<h4 id=\"description\">Description</h4>\n<p>Updates the list of <strong>Originating Service Providers (OSPs)</strong> assigned to a Entity.</p>\n<h4 id=\"path-variable\">Path Variable</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>entityCode</code></td>\n<td>String</td>\n<td>Unique identifier for the entity whose OSPs you want to manage.</td>\n<td><code>NUMEXXXXXXXO</code></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"business-validation\">Business Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Custom Error Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>NULL_CHECK_FOR_ENTITY_CODE</code></td>\n<td>EntityCode cannot be null or blank.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>INVALID_ENTITY_CODE</code></td>\n<td>Invalid entityCode {0}, please provide a valid entityCode.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>INVALID_ENTITY_MAPPING</td>\n<td>EntityCode {0}, is not mapped to your account. Please provide a valid entityCode.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>ORIGINATING_SERVICES_IS_NULL</code></td>\n<td>Originating Service Providers cannot be null or empty.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>MAXIMUM_OSPS</code></td>\n<td>Maximum of 5 Originating Service Providers allowed.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>INVALID_OSPS</code></td>\n<td>Invalid Originating Service Providers {0}.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>ACTION_ADD_DELETE</td>\n<td>Action must be either ADD or DELETE.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"respone\">Respone</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String (ISO)</td>\n<td>Time when the response was generated.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>The term \"SUCCESS\" signifies that the API call was successful.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message confirming the OSP update.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n</tr>\n<tr>\n<td><code>links.nextAction</code></td>\n<td>String</td>\n<td>Next recommended action URL for the entity (can be used for follow-up API calls).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","entity","NUMEXXXXXXXXX","osps"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"ebb55dee-a8c1-4214-ba54-190f2305aa48","name":"200-OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"action\": \"ADD\",\r\n  \"originatingServiceProviders\": [\r\n    \"Twilio\",\r\n    \"Barcks Corp\"\r\n  ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX/osps"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T02:49:06:06Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"Originating Service Providers (OSPs) have been successfully updated at the entity level.\",\r\n    \"path\": \"api/v1/svip/entity/NUMEXXXXXXXXXXX/osps\",\r\n    \"links\": {\r\n        \"nextAction\": \"api/v1/svip/entity/NUMEXXXXXXXXXXX\"\r\n    }\r\n}"},{"id":"78546fa5-c9bc-4a3a-a4fc-3c824c9beb78","name":"400-BadRequest","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"action\": \"Test\",\r\n  \"originatingServiceProviders\": [\r\n    \"Twilio\",\r\n    \"Barcks Corp\"\r\n  ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX/osps"},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T02:53:10:10Z\",\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Business validation failed for one or more fields.\",\r\n    \"path\": \"/dev2-eim/api/v1/svip/entity/INTE1755ABC1019/osps\",\r\n    \"details\": [\r\n        {\r\n            \"issue\": \"Action must be either ADD or DELETE.\",\r\n            \"customCode\": \"ACTION_ADD_DELETE\"\r\n        }\r\n    ]\r\n}"}],"_postman_id":"7bae044f-9b60-4aa2-b672-3683533696b2"},{"name":"Enable/Disable Feature","id":"24cfcd9a-e84b-45c9-9eb9-4e98402087c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"svipEnabled\":true\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX","description":"<h4 id=\"description\">Description</h4>\n<p>Enables or disables the <strong>sVIP feature</strong> for a specific entity. This controls whether the entity can participate in sVIP operations such as Number Profile management, CDR processing, and OSP assignment.</p>\n<h4 id=\"request-parameters\">Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example / Notes</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>entityId</code> (Path Variable)</td>\n<td>String</td>\n<td>Yes</td>\n<td>Unique identifier of the entity to update.</td>\n<td><code>NUMEXXXXX1019</code></td>\n</tr>\n<tr>\n<td><code>svipEnabled</code> (Body)</td>\n<td>Boolean</td>\n<td>Yes</td>\n<td>Flag to enable or disable the sVIP feature for the entity.</td>\n<td><code>true</code></td>\n</tr>\n<tr>\n<td><code>Authorization</code> (Header)</td>\n<td>String (Bearer token)</td>\n<td>Yes</td>\n<td>OAuth2 token for authentication.</td>\n<td><code>Bearer 71cXXXXXXXX-ec32b92a4e63</code></td>\n</tr>\n<tr>\n<td><code>Content-Type</code> (Header)</td>\n<td>String</td>\n<td>Yes</td>\n<td>Indicates request body format.</td>\n<td><code>application/json</code></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"business-validation\">Business Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>INVALID_ENTITY_CODE</td>\n<td>Invalid entityCode “{0}”, please provide a valid entityCode</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>INVALID_ENTITY_MAPPING</td>\n<td>EntityCode “{0}” is not mapped to your account. Please provide a valid entity code</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>ENTITY_NOT_SUBMITTED</td>\n<td>Entity with entityCode “{0}” is not in Submitted status. Please submit the entity before enabling the entity for sVIP</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>NULL_CHECK_FOR_ENTITY_CODE</td>\n<td>EntityCode cannot be null or blank</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>SVIP_ALREADY_ENABLED</td>\n<td>sVIP feature has already been enabled for this entityCode “{0}”</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>INVALID_SVIP_FLAG</td>\n<td>Invalid value for svipEnabled. Must be true or false.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>SVIP_ENABLED_NUMBER_PROFILE</td>\n<td>EntityCode {0} related Number Profiles are enabled for sVIP. Please disable Number Profiles before disabling the entity.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-parameters\">Response Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time of the response.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td><code>\"SUCCESS\"</code> if the request succeeded.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Confirmation message, e.g., <code>\"sVIP feature enabled successfully for the entity.\"</code></td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","entity","NUMEXXXXXXXXX"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"e0df0b1d-b263-496a-b015-fdc3b59bd9ef","name":"200-OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"svipEnabled\":true\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T03:03:12:12Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"SVIP has been successfully enabled for entityCode INTE1755ABC1019.\",\r\n    \"path\": \"api/v1/svip/entity/NUMEXXXXXXXXX\",\r\n    \"links\": {\r\n        \"nextAction\": \"/api/v1/svip/number-profile\"\r\n    }\r\n}"},{"id":"f6716944-dfee-4ce8-9c1d-f5ae5facbd7b","name":"400-BadRequest","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"svipEnabled\":true\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/svip/entity/NUMEXXXXXXXXX"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T02:59:56:56Z\",\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Business validation failed for one or more fields.\",\r\n    \"path\": \"/dev2-eim/api/v1/svip/entity/NUMEXXXXXXXXX\",\r\n    \"details\": [\r\n        {\r\n            \"issue\": \"sVIP feature has already been enabled for this entityCode NUMEXXXXXXXXX.\",\r\n            \"customCode\": \"CHECK_FOR_SVIP_EXIT\"\r\n        }\r\n    ]\r\n}"}],"_postman_id":"24cfcd9a-e84b-45c9-9eb9-4e98402087c5"},{"name":"Add Number profile to SVIP","id":"0912489d-9d2d-445d-bc00-96fac460a4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXXXXXXXX\",\r\n  \"attestationStatus\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile","description":"<h4 id=\"description\">Description</h4>\n<p>Adds a Number Profile to the sVIP system for a specific entity. This allows the number to be associated with the numberprofile and tracked under sVIP, with optional attestation status.</p>\n<h4 id=\"request-parameters\">Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field / Parameter</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>numberProfileId</code></td>\n<td>String</td>\n<td>✅ Yes</td>\n<td>Unique identifier of the number profile to update.</td>\n<td><code>NUMEXXXXXXXXXXXXXXXXXXXXXX</code></td>\n</tr>\n<tr>\n<td><code>attestationStatus</code></td>\n<td>Boolean</td>\n<td>✅ Yes</td>\n<td>Attestation status for the number profile (<code>true</code> = attested, <code>false</code> = not attested).</td>\n<td><code>false</code></td>\n</tr>\n<tr>\n<td><code>Authorization</code></td>\n<td>String (Bearer token)</td>\n<td>✅ Yes</td>\n<td>OAuth2 token for authentication.</td>\n<td><code>Bearer NUMEXXXXXXXXXXXXXXXXXXXXXXXX</code></td>\n</tr>\n<tr>\n<td><code>Content-Type</code></td>\n<td>String</td>\n<td>✅ Yes</td>\n<td>Specifies JSON request body format.</td>\n<td><code>application/json</code></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"input-validation\">Input Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>INVALID_NUMBER_PROFILE_ID</code></td>\n<td>✅ Yes</td>\n<td>NumberProfileID cannot be null or blank.</td>\n<td>400</td>\n</tr>\n<tr>\n<td><code>INVALID_ATTESTATION_STATUS</code></td>\n<td>❌ No</td>\n<td>AttestationStatus cannot be null or blank.</td>\n<td>400</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"business-validation\">Business Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>INVALID_NUMBER_PROFILE_ID</code></td>\n<td>Invalid numberProfileId “{0}”, please provide a valid numberProfileId</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>NUMBER_PROFILE_NOT_APPROVED</code></td>\n<td>Please ensure numberProfileId “{0}“ is in Approved status.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>NUMBER_PROFILE_NOT_ADDED_TO_SVIP</code></td>\n<td>Please ensure the NumberProfile “{0}” is added for sVIP.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>NULL_CHECK_FOR_NUMBER_PROFILE_ID</code></td>\n<td>numberProfileId “{0}” cannot be null or blank</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>INVALID_ATTESTATION_FLAG</td>\n<td>Invalid value for 'attestationStatus.' Must be true or false.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Response Parameters</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time when the response was generated.</td>\n<td><code>\"2025-10-01T04:39:02:02Z\"</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Indicates success or failure of the API call.</td>\n<td><code>\"SUCCESS\"</code></td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message about the API response.</td>\n<td><code>\"NumberProfile NUMEXXXXXXXXXXXXXXX has been successfully added to SVIP.\"</code></td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n<td><code>\"api/v1/svip/number-profile\"</code></td>\n</tr>\n<tr>\n<td><code>data.dirid</code></td>\n<td>String</td>\n<td>Unique internal ID assigned to the Number Profile.</td>\n<td><code>\"1ee47f4XXXXXXXXXXXXXX936cb766cd5\"</code></td>\n</tr>\n<tr>\n<td><code>data.submittedDate</code></td>\n<td>String</td>\n<td>Timestamp when the number profile was submitted to sVIP.</td>\n<td><code>\"2025-06-20T08:01:31.499167\"</code></td>\n</tr>\n<tr>\n<td><code>data.submittedBy</code></td>\n<td>String</td>\n<td>Email of the user who submitted the number profile.</td>\n<td><code>\"John.d@numeracle.com\"</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","number-profile"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"b9865016-255b-451b-9963-84f268fac318","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXXXXXXXX\",\r\n  \"attestationStatus\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T04:39:02:02Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"NumberProfile NUMEXXXXXXXXXXXXXXX has been successfully added to SVIP.\",\r\n    \"path\": \"api/v1/svip/number-profile\",\r\n    \"data\": {\r\n        \"dirid\": \"1ee47f4XXXXXXXXXXXXXX936cb766cd5\",\r\n        \"submittedDate\": \"2025-06-20T08:01:31.499167\",\r\n        \"submittedBy\":\"John.d@numeracle.com\"\r\n\r\n    }\r\n}"},{"id":"fceec783-47a4-4207-ab92-f00c890d7697","name":"400-BadRequest","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXXXXXXXX\",\r\n  \"attestationStatus\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T03:08:17:17Z\",\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Business validation failed for one or more fields.\",\r\n    \"path\": \"/dev2-eim/api/v1/svip/number-profile\",\r\n    \"details\": [\r\n        {\r\n            \"issue\": \"Invalid \\\"BPO / Call Center Vendor\\\" CVCV1\",\r\n            \"customCode\": \"INVALID_BPO\"\r\n        }\r\n    ]\r\n}"}],"_postman_id":"0912489d-9d2d-445d-bc00-96fac460a4ab"},{"name":"Delete Number profile from sVIP","id":"807a1963-0a2e-46d9-830d-ffa039cc30bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX","description":"<h4 id=\"description\">Description</h4>\n<p>Removes a Number Profile from the sVIP system. This action permanently deletes the profile along with its associated phone numbers.</p>\n<h4 id=\"path-variable\">Path Variable</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>numberProfileId</code></td>\n<td>String</td>\n<td>Unique identifier of the number profile to delete.</td>\n<td><code>NUMEXXXXXXXXXXXXXXX</code></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Business Validations</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>INVALID_NUMBER_PROFILE_ID</code></td>\n<td>Invalid numberProfileId {0}, please provide a valid numberProfileId.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>NUMBER_PROFILE_NOT_FOUND</code></td>\n<td>NumberProfile “{0}” does not exist or has already been deleted</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>SVIP_NOT_ENABLED</code></td>\n<td>sVIP feature is not enabled for this entity</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>CHECK_FOR_DIRID</code></td>\n<td>Please ensure NumberProfile {0} is added for sVIP.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-parameters\">Response Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time when the response was generated.</td>\n<td><code>\"2025-10-01T03:45:05:05Z\"</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Indicates the outcome of the API call.</td>\n<td><code>\"SUCCESS\"</code></td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message confirming the deletion.</td>\n<td><code>\"NumberProfile NUMEXXXXXXXXXXXXXXX has been successfully deleted from SVIP.\"</code></td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n<td><code>\"/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX\"</code></td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"c5bd7041-cec4-4844-b802-1b078f0240a1","id":"c5bd7041-cec4-4844-b802-1b078f0240a1","name":"Numeracle API-V1.0.0 SVIP","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","svip","number-profile","NUMEXXXXXXXXXXXXXXX"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"d20f87c5-3f2d-4859-a84b-7be44652bd5a","name":"200-OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T03:45:05:05Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"NumberProfile NUMEXXXXXXXXXXXXXXX has been successfully deleted from SVIP.\",\r\n    \"path\": \"/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX\"\r\n}"},{"id":"f47084ec-d174-404f-91d6-dafe9755e745","name":"400-BadRequest","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T04:25:28:28Z\",\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Business validation failed for one or more fields.\",\r\n    \"path\": \"/dev2-eim/api/v1/svip/number-profile/NUMEXXXXXXXXXXXXXXX\",\r\n    \"details\": [\r\n        {\r\n            \"issue\": \"Invalid numberProfileId NUMEXXXXXXXXXXXXXXX, please provide a valid numberProfileId.\",\r\n            \"customCode\": \"CHECK_FOR_NUMBER_PROFILE\"\r\n        }\r\n    ]\r\n}"}],"_postman_id":"807a1963-0a2e-46d9-830d-ffa039cc30bf"},{"name":"Get Enterprise Details","id":"e30d12e9-6958-4c16-ab3f-6c7a514e3c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/enterpriseDetails/NUMEXXXXXX","description":"<h4 id=\"description\"><strong>Description</strong></h4>\n<p>Retrieves detailed information about an enterprise (entity) in the sVIP system. This includes basic entity information such as the entity name, internal entity ID (<code>eid</code>), and other metadata. Useful for auditing, display, or integration purposes.</p>\n<p><strong>Path Variable</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>entityCode</code></td>\n<td>String</td>\n<td>Unique identifier of the entity to retrieve details for.</td>\n<td><code>NUMEXXXXXX</code></td>\n</tr>\n</tbody>\n</table>\n</div><p>Business Validation</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th><strong>HTTP Message</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>NULL_CHECK_FOR_ENTITY_CODE</code></td>\n<td>EntityCode cannot be null or blank.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>INVALID_ENTITY_CODE</code></td>\n<td>Invalid entityCode “{0}”, please provide a valid entityCode</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td>INVALID_ENTITY_MAPPING</td>\n<td>EntityCode “{0}” is not mapped to your account.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-parameters\">Response Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time when the response was generated.</td>\n<td><code>\"2025-10-01T04:39:02:02Z\"</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Indicates success or failure of the API call.</td>\n<td><code>\"SUCCESS\"</code></td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message about the API response.</td>\n<td><code>\"Enterprise details for entityCode NUMEXXXXXXX.\"</code></td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n<td><code>\"api/v1/svip/enterpriseDetails/NUMEXXXXXXX\"</code></td>\n</tr>\n<tr>\n<td><code>data.entityName</code></td>\n<td>String</td>\n<td>Name of the enterprise/entity.</td>\n<td><code>\"ABC Testing\"</code></td>\n</tr>\n<tr>\n<td><code>data.eid</code></td>\n<td>String</td>\n<td>Internal unique ID assigned to the entity.</td>\n<td><code>\"1ee47f43c91c602c9f1ee936cb766cd5\"</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","enterpriseDetails","NUMEXXXXXX"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"c714c712-87b2-49f2-ac52-1d11e4970c78","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/enterpriseDetails/NUMEXXXXXXX"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T04:39:02:02Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"Enterprise details for entityCode NUMEXXXXXXX.\",\r\n    \"path\": \"api/v1/svip/enterpriseDetails/NUMEXXXXXXX\",\r\n    \"data\": {\r\n        \"entityName\": \"ABC Testing\",\r\n        \"eid\": \"1ee47f43c91c602c9f1ee936cb766cd5\"\r\n    }\r\n}"}],"_postman_id":"e30d12e9-6958-4c16-ab3f-6c7a514e3c1d"},{"name":"Get CDR Details","id":"9e62134e-c708-4df5-a967-dc18adbf94ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer <token>","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/svip/cdr?lastRecordId=0&limit=10","description":"<h4 id=\"description\">Description</h4>\n<p>The CDR API retrieves a list of <strong>Call Detail Records (CDRs)</strong> for entities in the sVIP system. These records provide detailed information about calls associated with an entity, including originating and destination numbers, originating service provider (OSP), number profiles, claims status, and audit-related metadata.</p>\n<h4 id=\"rate-limit\">Rate limit</h4>\n<p><strong>10 hits per 10 minutes</strong> per source IP address.</p>\n<p>Exceeding this limit returns <strong>HTTP 429</strong>. Wait for the rolling 10-minute window to allow more requests, then retry.</p>\n<p><code>limit</code> remains 1–1000 (typically 1000). Rate limiting applies to the HTTP request count, not the number of CDR rows returned.</p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th><strong>Required</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>lastRecordId</code></td>\n<td>Integer</td>\n<td>✅ Yes</td>\n<td>The maximum id used to retrieve the current batch of records. This parameter is also a part of response parameter that the api user uses to retrieve the next set of records.</td>\n<td><code>0</code></td>\n</tr>\n<tr>\n<td><code>limit</code></td>\n<td>Integer</td>\n<td>✅ Yes</td>\n<td>limit refers to the maximum count of records to be retrieved per batch, default and max limit is 1000</td>\n<td><code>10</code></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"business-validation\"><strong>Business Validation</strong></h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Custom Error Code</strong></th>\n<th><strong>Message</strong></th>\n<th><strong>HTTP Status Code</strong></th>\n<th>Http Status Text</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>MALFORMED_REQUEST_PARAMETERS</td>\n<td>Malformed request parameters. Check the request parameters.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>CHECK_FOR_LASTRECORD_ID_MIN</code></td>\n<td>LastRecordId must be greater than or equal to 0.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>LIMIT_COUNT_VALIDATION</code></td>\n<td>Limit must be less than or equal to 1000.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n<tr>\n<td><code>CHECK_FOR_LIMIT_MIN</code></td>\n<td>Limit count must be greater than 0.</td>\n<td>422</td>\n<td>Unprocessable Content</td>\n</tr>\n</tbody>\n</table>\n</div><p>Response Parameters</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>timestamp</code></td>\n<td>String</td>\n<td>Time when the response was generated.</td>\n<td><code>\"2025-10-01T04:55:58:58Z\"</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Status of the API call (<code>SUCCESS</code> / <code>FAILURE</code>).</td>\n<td><code>\"SUCCESS\"</code></td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>String</td>\n<td>Descriptive message about the response.</td>\n<td><code>\"CDR details\"</code></td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>String</td>\n<td>API endpoint that was called.</td>\n<td><code>\"api/v1/svip/cdr\"</code></td>\n</tr>\n<tr>\n<td><code>data.records</code></td>\n<td>Array</td>\n<td>List of Call Detail Records (CDRs). Each record contains detailed info.</td>\n<td>See below</td>\n</tr>\n<tr>\n<td><code>data.lastRecordId</code></td>\n<td>Integer</td>\n<td>ID of the last record returned; used for pagination.</td>\n<td><code>3</code></td>\n</tr>\n<tr>\n<td><code>data.hasMoreRecords</code></td>\n<td>Boolean</td>\n<td>Indicates if more records exist beyond this batch.</td>\n<td><code>true</code></td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"individual-cdr-record-fields\"><strong>Individual CDR Record Fields</strong></h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>Integer</td>\n<td>Internal ID of the CDR.</td>\n<td><code>1</code></td>\n</tr>\n<tr>\n<td><code>eid</code></td>\n<td>String</td>\n<td>Entity ID associated with the CDR.</td>\n<td><code>\"1f04aabe1efb69a5bd4c75c9da19350e\"</code></td>\n</tr>\n<tr>\n<td><code>dirid</code></td>\n<td>String</td>\n<td>Unique internal ID for the directory/number profile.</td>\n<td><code>\"cdba3ccf2d654981a6e0a46cd91df623\"</code></td>\n</tr>\n<tr>\n<td><code>sig</code></td>\n<td>String</td>\n<td>Signature or unique CDR signature.</td>\n<td><code>\"zBBw8rRN2wdB9AtNzOZDq1ZQxn3OCPYE...\"</code></td>\n</tr>\n<tr>\n<td><code>claimsRequested</code></td>\n<td>String</td>\n<td>Claims requested for this call (may be blank).</td>\n<td><code>\"\"</code></td>\n</tr>\n<tr>\n<td><code>claimsSigned</code></td>\n<td>String</td>\n<td>Claims signed for call N = nam  <br />NC = nam and crn  <br />NL = nam and logo  <br />NLC = nam, logo, and crn</td>\n<td><code>\"NL\"</code></td>\n</tr>\n<tr>\n<td><code>claimsPassed</code></td>\n<td>String</td>\n<td>Result of claims validation (<code>NL</code>, <code>NLC</code>, etc.).</td>\n<td><code>\"NL\"</code></td>\n</tr>\n<tr>\n<td><code>dest</code></td>\n<td>String</td>\n<td>Destination phone number (if available).</td>\n<td><code>\"13334567890\"</code></td>\n</tr>\n<tr>\n<td><code>tspName</code></td>\n<td>String</td>\n<td>Name of Terminating Service Provider</td>\n<td><code>\"tmobile-tsp\"</code></td>\n</tr>\n<tr>\n<td><code>orig</code></td>\n<td>String</td>\n<td>Originating phone number (if available).</td>\n<td><code>\"19990000119\"</code></td>\n</tr>\n<tr>\n<td><code>bpoid</code></td>\n<td>String</td>\n<td>Business profile ID associated with the call.</td>\n<td><code>\"1efde871fe396d069b56b32f8d5c2c22\"</code></td>\n</tr>\n<tr>\n<td><code>ospid</code></td>\n<td>String</td>\n<td>Originating Service Provider ID.</td>\n<td><code>\"twilio-osp\"</code></td>\n</tr>\n<tr>\n<td><code>said</code></td>\n<td>String</td>\n<td>Service account ID associated with the call.</td>\n<td><code>\"twilio-sa\"</code></td>\n</tr>\n<tr>\n<td><code>iat</code></td>\n<td>Integer</td>\n<td>Timestamp of when the record was created (epoch seconds).</td>\n<td><code>1746080105</code></td>\n</tr>\n<tr>\n<td><code>entityName</code></td>\n<td>String</td>\n<td>Name of the entity associated with the CDR.</td>\n<td><code>\"TestEntity_SVIP_16\"</code></td>\n</tr>\n<tr>\n<td><code>brandName</code></td>\n<td>String</td>\n<td>Brand name associated with the CDR.</td>\n<td><code>\"TestEntity_SVIP_16\"</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","v1","svip","cdr"],"host":["www","sandbox","numeracle","com"],"query":[{"key":"lastRecordId","value":"0"},{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"a44f10c4-6412-4457-ac21-def24cf32f00","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/svip/cdr?lastRecordId=0&limit=10","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","svip","cdr"],"query":[{"key":"lastRecordId","value":"0"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T04:55:58:58Z\",\r\n    \"status\": \"SUCCESS\",\r\n    \"message\": \"CDR details\",\r\n    \"path\": \"api/v1/svip/cdr\",\r\n    \"data\": {\r\n\t\r\n  \"records\": [\r\n    {\r\n      \"id\": 1,\r\n      \"eid\": \"1f04aabe1efb69a5bd4c75c9da19350e\",\r\n      \"dirid\": \"cdba3ccf2d654981a6e0a46cd91df623\",\r\n      \"sig\": \"zBBw8rRN2wdB9AtNzOZDq1ZQxn3OCPYE2LhooihuFN2A5VZI3fWN9muB81glzpvtaI-4VccFAc-ozx0P166E0g\",\r\n      \"claimsRequested\": \"\",\r\n      \"claimsSigned\": \"NLC\",\r\n      \"claimsPassed\": \"NC\",\r\n      \"tspName\":\"tmobile-tsp\"\r\n      \"dest\": \"\",\r\n      \"orig\": \"\",\r\n      \"bpoid\": \"\",\r\n      \"ospid\": \"twilio-osp\",\r\n      \"said\": \"twilio-sa\",\r\n      \"iat\": 1746080105,\r\n      \"entityName\": \"TestEntity_SVIP_16\",\r\n      \"brandName\": \"TestEntity_SVIP_16\"\r\n    },\r\n    {\r\n      \"id\": 2,\r\n      \"eid\": \"1f04aabe1efb69a5bd4c75c9da19350e\",\r\n      \"dirid\": \"cdba3ccf2d654981a6e0a46cd91df623\",\r\n      \"sig\": \"D5NY1MRvanRcyxcbnYtd9iUKL2i1-ZsnsSmHvZ-t_E7ESX56xYAuovVyx2ZJtwuJr489OZ6zJ_7nm0WitnqPaw\",\r\n      \"claimsRequested\": \"\",\r\n      \"claimsSigned\": \"NLC\",\r\n      \"claimsPassed\": \"NL\",\r\n      \"tspName\":\"tmobile-tsp\"\r\n      \"dest\": \"\",\r\n      \"orig\": \"\",\r\n      \"bpoid\": \"\",\r\n      \"ospid\": \"twilio-osp\",\r\n      \"said\": \"twilio-sa\",\r\n      \"iat\": 1746080105,\r\n      \"entityName\": \"TestEntity_SVIP_16\",\r\n      \"brandName\": \"TestEntity_SVIP_16\"\r\n    },\r\n    {\r\n      \"id\": 3,\r\n      \"eid\": \"1f04aabe1efb69a5bd4c75c9da19350e\",\r\n      \"dirid\": \"cdba3ccf2d654981a6e0a46cd91df623\",\r\n      \"sig\": \"VLLFyyOMD_P7fW_g0j7dTKG2JLkidwbpJ4aMEbrjyctnO3aewv9hpPWo_Ts95uZfj3AXzCi3FyTli7PSzMt0Nw\",\r\n      \"claimsRequested\": \"\",\r\n      \"claimsSigned\": \"NLC\",\r\n      \"claimsPassed\": \"NLC\",\r\n      \"tspName\":\"tmobile-tsp\"\r\n      \"dest\": \"13334567890\",\r\n      \"orig\": \"19990000119\",\r\n      \"bpoid\": \"1efde871fe396d069b56b32f8d5c2c22\",\r\n      \"ospid\": \"bbdynamics-osp\",\r\n      \"said\": \"sansay-sa\",\r\n      \"iat\": 1746080105,\r\n      \"entityName\": \"TestEntity_SVIP_16\",\r\n      \"brandName\": \"TestEntity_SVIP_16\"\r\n    }\r\n\t]\r\n\t],\r\n  \"lastRecordId\": 3,\r\n  \"hasMoreRecords\": true\r\n\r\n    }\r\n\t}"},{"id":"9c9b4024-f1c7-4212-aeb9-edcb010504a1","name":"400-BadRequest","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer <token>","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/svip/cdr?lastRecordId=-1&limit=10","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","svip","cdr"],"query":[{"key":"lastRecordId","value":"-1"},{"key":"limit","value":"10"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n    \"timestamp\": \"2025-10-01T05:05:39:39Z\",\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Business validation failed for one or more fields.\",\r\n    \"path\": \"/dev2-eim/api/v1/svip/cdr\",\r\n    \"details\": [\r\n        {\r\n            \"issue\": \"LastRecordId must be greater than or equal to 0.\",\r\n            \"customCode\": \"CHECK_FOR_LASTRECORD_ID_MIN\"\r\n        }\r\n    ]\r\n}"}],"_postman_id":"9e62134e-c708-4df5-a967-dc18adbf94ba"}],"id":"f6c6c165-ba37-4706-96a9-b3b72d2cebb9","_postman_id":"f6c6c165-ba37-4706-96a9-b3b72d2cebb9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"c5bd7041-cec4-4844-b802-1b078f0240a1","id":"c5bd7041-cec4-4844-b802-1b078f0240a1","name":"Numeracle API-V1.0.0 SVIP","type":"collection"}}}],"id":"396f5667-355f-4929-af56-5a586668b66d","_postman_id":"396f5667-355f-4929-af56-5a586668b66d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":true,"source":{"_postman_id":"c5bd7041-cec4-4844-b802-1b078f0240a1","id":"c5bd7041-cec4-4844-b802-1b078f0240a1","name":"Numeracle API-V1.0.0 SVIP","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"9b01a657-7a3b-4a9c-978c-a4c3cceca65a"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"bbc54f0a-bf61-4509-a61a-d1524e0c23a0"}}],"variable":[{"key":"https://dev2-eim.numeracle.com/","value":""},{"key":"intent","value":""}]}