{"info":{"_postman_id":"743351a6-0425-4eeb-96a3-5739a7764381","name":"API Documentation","description":"<html><head></head><body><h1 id=\"vitelity-customer-api-v2\">Vitelity Customer Api - V2</h1>\n<p>New JSON based apis for common vitelity functions. First release will be LNP related api calls only.</p>\n<h1 id=\"authentication\">Authentication</h1>\n<p>Basic auth of account/api username and password</p>\n<h1 id=\"error-codes\">Error Codes</h1>\n<p>422 - missing required field or invalid field</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Vitelity Customer Api - V2","slug":"vitelity-customer-api-v2"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"}],"owner":"7215246","collectionId":"743351a6-0425-4eeb-96a3-5739a7764381","publishedId":"2s93JutNXT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-15T00:34:46.000Z"},"item":[{"name":"LNP","item":[{"name":"checkPortability","id":"b2ed2108-a732-4b7d-89fd-ecc7f969eb94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"numbers\":[\"3033003000\",\"1001001000\",\"8008008000\",\"9702002000\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/checkPortability","description":"<p>Check portability of multiple numbers local and tollfree</p>\n","urlObject":{"protocol":"https","path":["2.0","lnp","checkPortability"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[{"id":"a84520d7-80d4-4212-b7b2-30eb1787e114","name":"checkPortability","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"numbers\":[\"3033003000\",\"1001001000\",\"8008008000\",\"9702002000\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/checkPortability"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Success\",\n    \"statusCode\": 200,\n    \"error\": null,\n    \"serviceAvailable\": [\n        {\n            \"telephoneNumber\": \"3033003000\",\n            \"isPortable\": true\n        },\n        {\n            \"telephoneNumber\": \"9702002000\",\n            \"isPortable\": true\n        },\n        {\n            \"telephoneNumber\": \"1001001000\",\n            \"isPortable\": false\n        },\n        {\n            \"telephoneNumber\": \"8008008000\",\n            \"isPortable\": false\n        }\n    ]\n}"}],"_postman_id":"b2ed2108-a732-4b7d-89fd-ecc7f969eb94"},{"name":"portInOrder","id":"22234371-d23d-4505-9ff0-232548545d9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ratePlan\": \"PPM\",\n    \"accountNum\": \"123456\",\n    \"atn\": \"3033003000\",\n    \"authName\": \"Bob\",\n    \"routingMethod\": \"NONE\",\n    \"addressName\": \"Bob\",\n    \"streetNum\": \"2200\",\n    \"streetName\": \"Briargate\",\n    \"streetType\": \"St.\",\n    \"city\": \"Denver\",\n    \"state\": \"CO\",\n    \"postalCode\": \"80112\",\n    \"desiredDueDate\": \"2023-03-05\",\n    \"onDemandActivation\": \"Y\",\n    \"numbers\": [\n        \"3031001000\",\n        \"3031001001\"\n    ],\n    \"typeOfService\": \"R\",\n    \"accountPin\": \"0000\",\n    \"portOutPin\": \"0000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/portInOrder","description":"<p>Port in request for non tollfree numbers</p>\n","urlObject":{"protocol":"https","path":["2.0","lnp","portInOrder"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[{"id":"67b5313e-82a9-4133-be03-bdd6a5312942","name":"portInOrder","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ratePlan\": \"PPM\",\n    \"accountNum\": \"123456\",\n    \"atn\": \"3033003000\",\n    \"authName\": \"Bob\",\n    \"routingMethod\": \"NONE\",\n    \"addressName\": \"Bob\",\n    \"streetNum\": \"2200\",\n    \"streetName\": \"Briargate\",\n    \"streetType\": \"St.\",\n    \"city\": \"Denver\",\n    \"state\": \"CO\",\n    \"postalCode\": \"80112\",\n    \"desiredDueDate\": \"2023-03-05\",\n    \"onDemandActivation\": \"Y\",\n    \"numbers\": [\n        \"3031001000\",\n        \"3031001001\"\n    ],\n    \"typeOfService\": \"R\",\n    \"accountPin\": \"0000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/portInOrder"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Success\",\n    \"statusCode\": 200,\n    \"error\": null,\n    \"orderId\": \"71799944\"\n}"}],"_postman_id":"22234371-d23d-4505-9ff0-232548545d9f"},{"name":"portInOrderTf Form","id":"7bfb9696-18f1-4052-94e3-c6d5d1e1b150","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ratePlan","value":"PPM","type":"text"},{"key":"numbers","value":"8338338333","type":"text"},{"key":"loa","type":"file","src":"/Users/lsaruwatari/Downloads/dummy.pdf"},{"key":"subaccount","value":"sub1","type":"text"}]},"url":"https://api.vitelity.net/2.0/lnp/portInTfFormOrder","description":"<p>Port in a tollfree number or numbers</p>\n","urlObject":{"protocol":"https","path":["2.0","lnp","portInTfFormOrder"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[{"id":"d5159554-7479-468f-b7fb-9960fc22c581","name":"portInOrderTf Form","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ratePlan","value":"PPM","type":"text"},{"key":"numbers","value":"8338338333","type":"text"},{"key":"loa","type":"file","src":"/Users/lsaruwatari/Downloads/dummy.pdf"},{"key":"subaccount","value":"sub1","type":"text"}]},"url":"https://api.vitelity.net/2.0/lnp/portInTfFormOrder"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Success\",\n    \"statusCode\": 200,\n    \"error\": null,\n    \"orderId\": \"71874588\",\n    \"documentId\": \"2017237\"\n}"}],"_postman_id":"7bfb9696-18f1-4052-94e3-c6d5d1e1b150"},{"name":"getPortOrders","id":"c23839b5-559a-4c49-823b-8d0bf3719811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/orders?page=1&size=20","description":"<p>Port in a tollfree number or numbers</p>\n","urlObject":{"protocol":"https","path":["2.0","lnp","orders"],"host":["api","vitelity","net"],"query":[{"key":"page","value":"1"},{"key":"size","value":"20"}],"variable":[]}},"response":[{"id":"cb20d1b4-5e35-42f4-be91-6f3a8c77dabc","name":"portInOrderTf Form","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ratePlan","value":"PPM","type":"text"},{"key":"numbers","value":"8338338333","type":"text"},{"key":"loa","type":"file","src":"/Users/lsaruwatari/Downloads/dummy.pdf"},{"key":"subaccount","value":"sub1","type":"text"}]},"url":"https://api.vitelity.net/2.0/lnp/portInTfFormOrder"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Success\",\n    \"statusCode\": 200,\n    \"error\": null,\n    \"orderId\": \"71874588\",\n    \"documentId\": \"2017237\"\n}"}],"_postman_id":"c23839b5-559a-4c49-823b-8d0bf3719811"},{"name":"getPortOrdersById","id":"4f182067-6200-4c8e-b69f-a146b3b1cd9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/lnp/orders/123456789","description":"<p>Port in a tollfree number or numbers</p>\n","urlObject":{"protocol":"https","path":["2.0","lnp","orders","123456789"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[{"id":"b4b265bf-7adf-4b7f-88dc-6bf743444b38","name":"portInOrderTf Form","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ratePlan","value":"PPM","type":"text"},{"key":"numbers","value":"8338338333","type":"text"},{"key":"loa","type":"file","src":"/Users/lsaruwatari/Downloads/dummy.pdf"},{"key":"subaccount","value":"sub1","type":"text"}]},"url":"https://api.vitelity.net/2.0/lnp/portInTfFormOrder"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Success\",\n    \"statusCode\": 200,\n    \"error\": null,\n    \"orderId\": \"71874588\",\n    \"documentId\": \"2017237\"\n}"}],"_postman_id":"4f182067-6200-4c8e-b69f-a146b3b1cd9a"}],"id":"0d911f16-a52b-4cbb-a816-994f307049da","_postman_id":"0d911f16-a52b-4cbb-a816-994f307049da","description":""},{"name":"DID","item":[{"name":"searchLocal","id":"39ef1b37-c5ae-45f2-b877-4783dccffdc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"tnMask\": \"970XXX1234\",\n    \"sortDir\": \"asc\",\n    \"quantity\": 10,\n    \"page\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/local/search","urlObject":{"protocol":"https","path":["2.0","did","local","search"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"39ef1b37-c5ae-45f2-b877-4783dccffdc0"},{"name":"searchLocalVanity","id":"23536934-83af-4af7-9b6c-6555251b42c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"tnWildcard\": \"*ABCD\",\n    \"sortDir\": \"asc\",\n    \"quantity\": 10,\n    \"page\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/local/search/vanity","urlObject":{"protocol":"https","path":["2.0","did","local","search","vanity"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"23536934-83af-4af7-9b6c-6555251b42c3"},{"name":"orderLocal","id":"44b03e7c-1ffc-4d55-aa34-abff72ba4873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ratePlan\": \"UNLIMITED\",\n    \"vfax\": false,\n    \"numbers\": [\"9701001000\", \"9701002000\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/local/order","urlObject":{"protocol":"https","path":["2.0","did","local","order"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"44b03e7c-1ffc-4d55-aa34-abff72ba4873"},{"name":"searchTollfree","id":"92f8d308-d802-4889-9fc2-272f88bb4788","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"tnMask\": \"833XXX1234\",\n    \"quantity\": 10,\n    \"sequential\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/tollfree/search","urlObject":{"protocol":"https","path":["2.0","did","tollfree","search"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"92f8d308-d802-4889-9fc2-272f88bb4788"},{"name":"searchTollfreeVanity","id":"117090b8-bc44-43a8-a8d8-278e7bd14537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"tnWildcard\": \"*ABCD\",\n    \"quantity\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/tollfree/search/vanity","urlObject":{"protocol":"https","path":["2.0","did","tollfree","search","vanity"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"117090b8-bc44-43a8-a8d8-278e7bd14537"},{"name":"orderTollfree","id":"2aef0b7d-ae6e-4a0c-9d45-d60bd6d18637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"ratePlan\": \"UNLIMITED\",\n    \"vfax\": false,\n    \"numbers\": [\"8331001000\",\"8331002000\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/tollfree/order","urlObject":{"protocol":"https","path":["2.0","did","tollfree","order"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"2aef0b7d-ae6e-4a0c-9d45-d60bd6d18637"},{"name":"getOrders","id":"9734552b-6c2a-4299-9626-e1c4328312a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"<username>"},{"key":"password","value":"<password>"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n    \"direction\": \"asc\",\n    \"size\": 50,\n    \"page\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vitelity.net/2.0/did/orders","urlObject":{"protocol":"https","path":["2.0","did","orders"],"host":["api","vitelity","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"9734552b-6c2a-4299-9626-e1c4328312a5"}],"id":"ef9bc5f5-1f9b-4ea9-b845-f10e973a8891","_postman_id":"ef9bc5f5-1f9b-4ea9-b845-f10e973a8891","description":""}]}