{"info":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","description":"

API web services for integrating with NVMS, Inc.

Complete collection covering all Exchange controller endpoints.

Usage:

Set the baseUrl collection variable to the API host.
\n
Run the request in the Authentication folder with your credentials — the access token is saved to the token collection variable automatically.
\n
All Exchange requests use that token via collection-level Bearer auth.
\n

All endpoints return an NVMSAppResponse envelope: { code, status (Success/NoRecords/Error), message, results, ResultReference[], errors[] }. A 200 response does not guarantee business success — check the status field.

Contact Support:
Name: NVMS, Inc.
Email: support@nvms.com

Production URL: https://api.nvms.com

Sandbox URL: https://sandbox.nvms.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7428775","collectionId":"861e0dce-29b4-46c0-ac4c-881750239164","publishedId":"2sBY4PNKZb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"283046","highlight":"2147B1"},"publishDate":"2026-07-17T13:42:46.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get access token (password grant)","event":[{"listen":"test","script":{"exec":["if (pm.response.code === 200) {"," var body = pm.response.json();"," if (body.access_token) {"," pm.collectionVariables.set('token', body.access_token);"," console.log('Token saved to collection variable.');"," }","}"],"type":"text/javascript","id":"5c5c06c4-0fd8-435f-b677-672111d1937a"}}],"id":"2c037df4-5bcd-45fa-84e7-0ae20e602ab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"password\",\n \"username\": \"\",\n \"password\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/services/token","description":"

Obtain an OAuth 2.0 bearer token. On success the access_token is automatically saved to the collection token variable used by all other requests. An authorization_code grant (client_id, client_secret, code) is also supported. NOT NEEDED FOR REGULAR WEB SERVICE AUTH - FOR FANNIE MAE ONLY

\n","urlObject":{"path":["services","token"],"host":["https://your-nvms-host"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c037df4-5bcd-45fa-84e7-0ae20e602ab6"}],"id":"59ee468e-f497-4481-b052-f679e7253a3e","description":"

Token issuance (services controller). Run this first.

\n","_postman_id":"59ee468e-f497-4481-b052-f679e7253a3e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}}},{"name":"Order Submission","item":[{"name":"NewOrders - Submit inspection order(s)","id":"8914f2a5-5558-4d6b-90ab-ebb8b0ce9331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"FileNumber\": \"TEST1234\",\n \"PropAddress\": \"123 Main Street\",\n \"PropCity\": \"Anytown\",\n \"PropState\": \"VA\",\n \"PropZip\": \"20112\",\n \"PropOwner\": \"John Doe\",\n \"PropDesc\": \"Single family residence\",\n \"Services\": \"\",\n \"UserID\": 9283,\n \"PONumber\": \"PO-001\",\n \"dbaName\": \"Branch or DBA name\",\n \"AccContact\": \"Access contact name\",\n \"AccMobile\": \"555-555-1234\",\n \"AccHome\": \"555-555-5678\",\n \"AccWork\": \"555-555-9012\",\n \"AccEmail\": \"contact@example.com\",\n \"CallbackReference\": \"Your callback reference\",\n \"Notes\": \"Order notes\",\n \"ReportHTML\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/exchange/NewOrders","description":"

Submit one or more new inspection orders (JSON array — batch supported). Each created order is returned in ResultReference with FileNumber, OrderID, and Link.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}},"urlObject":{"path":["exchange","NewOrders"],"host":["https://your-nvms-host"],"query":[],"variable":[]}},"response":[],"_postman_id":"8914f2a5-5558-4d6b-90ab-ebb8b0ce9331"},{"name":"NewDrawOrder - Submit draw order(s)","id":"91f682d7-45ea-442b-9fb4-da61515c9150","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"FileNumber\": \"TEST1234\",\n \"PropAddress\": \"123 Main Street\",\n \"PropCity\": \"Anytown\",\n \"PropState\": \"VA\",\n \"PropZip\": \"20112\",\n \"PropOwner\": \"John Doe\",\n \"PropDesc\": \"Single family residence\",\n \"Services\": \"\",\n \"UserID\": 9283,\n \"PONumber\": \"PO-001\",\n \"dbaName\": \"Branch or DBA name\",\n \"AccContact\": \"Access contact name\",\n \"AccMobile\": \"555-555-1234\",\n \"AccHome\": \"555-555-5678\",\n \"AccWork\": \"555-555-9012\",\n \"AccEmail\": \"contact@example.com\",\n \"CallbackReference\": \"Your callback reference\",\n \"Notes\": \"Order notes\",\n \"ReportHTML\": \"\",\n \"DrawItemsList\": [\n {\n \"DrawReference\": \"121\",\n \"DrawItem\": \"Contingency\",\n \"DrawDescription\": \"Contingency\",\n \"DrawBudget\": 500\n },\n {\n \"DrawReference\": \"122\",\n \"DrawItem\": \"Division_22\",\n \"DrawDescription\": \"Test 2\",\n \"DrawBudget\": 600\n },\n {\n \"DrawReference\": \"123\",\n \"DrawItem\": \"Division_21\",\n \"DrawDescription\": \"Test 3\",\n \"DrawBudget\": 700\n }\n ],\n \"DocumentsList\": [\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument.pdf\",\n\t\t\t\t\"DocumentType\": \"pdf\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document\",\n\t\t\t\t\"Document\": \"JVBERi0xLjQKJcfsj6I... [Base64]\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument2.pdf\",\n\t\t\t\t\"DocumentType\": \"PDF\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document again\",\n\t\t\t\t\"Document\": \"JVBERi0xLjYNJeLjz9MN...[Base64]\"\n\t\t\t}\n\t\t]\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/exchange/NewDrawOrder","description":"

Submit one or more new draw orders. Same body as NewOrders plus a DrawItemsList array per order. DocumentsList array is optional. If you don't wish to upload documents, just leave this out of the POST body.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}},"urlObject":{"path":["exchange","NewDrawOrder"],"host":["https://your-nvms-host"],"query":[],"variable":[]}},"response":[],"_postman_id":"91f682d7-45ea-442b-9fb4-da61515c9150"},{"name":"NewCTCOrder - Submit CTC order(s)","id":"1720095f-47e6-425b-a0be-d012d3aeb3c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"FileNumber\": \"CTC123456ABCDEF\",\n\t\t\"PropOwner\": \"Entity of Avrekh Fayzakov\",\n\t\t\"PropAddress\": \"837 East 49th St\",\n\t\t\"PropCity\": \"Brooklyn\",\n\t\t\"PropState\": \"NY\",\n\t\t\"PropZip\": \"11203\",\n\t\t\"UserID\": 61166,\n\t\t\"dbaName\": \"States Capital LLC\",\n\t\t\"AccContact\": \"Avi Alishaev\",\n\t\t\"AccMobile\": \"7035551212\",\n\t\t\"AccEmail\": \" test@gmail.com\",\n\t\t\"CallbackReference\": \"https://mysite.com/webhook?id=67b76ffbce666300062540cb\",\n\t\t\"Notes\": \"Please share the link to me\",\n\t\t\"Services\": \"8305\",\n\t\t\"CTCDetailsList\": [\n {\n\t\t\t\t\"FieldName\": \"CLOSETS\",\n\t\t\t\t\"Description\": \"CLOSETS\",\n\t\t\t\t\"Notes\": \"\",\n\t\t\t\t\"Dimensions\": \"\",\n\t\t\t\t\"BudgetEstimate\": 8000.0\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"FieldName\": \"DESIGNER-STAGING\",\n\t\t\t\t\"Description\": \"DESIGNER/STAGING\",\n\t\t\t\t\"Notes\": \"\",\n\t\t\t\t\"Dimensions\": \"\",\n\t\t\t\t\"BudgetEstimate\": 11350.0\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"FieldName\": \"ARCHITECT\",\n\t\t\t\t\"Description\": \"ARCHITECT\",\n\t\t\t\t\"Notes\": \"\",\n\t\t\t\t\"Dimensions\": \"\",\n\t\t\t\t\"BudgetEstimate\": 10200.0\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"FieldName\": \"SURVEY\",\n\t\t\t\t\"Description\": \"SURVEY\",\n\t\t\t\t\"Notes\": \"\",\n\t\t\t\t\"Dimensions\": \"\",\n\t\t\t\t\"BudgetEstimate\": 850.0\n\t\t\t}\n ],\n\t\t\"DocumentsList\": [\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument.pdf\",\n\t\t\t\t\"DocumentType\": \"pdf\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document\",\n\t\t\t\t\"Document\": \"JVBERi0xLjQKJcfsj6I... [Base64]\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument2.pdf\",\n\t\t\t\t\"DocumentType\": \"PDF\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document again\",\n\t\t\t\t\"Document\": \"JVBERi0xLjYNJeLjz9MN...[Base64]\"\n\t\t\t}\n\t\t]\n\t\t\n\t}\n]","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/exchange/NewCTCOrder","description":"

Submit one or more new CTC orders. Same body shape as NewOrders. DocumentsList array is optional. If you don't wish to upload documents, just leave this out of the POST body.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}},"urlObject":{"path":["exchange","NewCTCOrder"],"host":["https://your-nvms-host"],"query":[],"variable":[]}},"response":[],"_postman_id":"1720095f-47e6-425b-a0be-d012d3aeb3c8"},{"name":"NewDocumentOrder - Submit document order(s)","id":"79b06c33-78ff-47e2-bbb3-3c61c45a361c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"FileNumber\": \"TEST1234\",\n \"PropAddress\": \"123 Main Street\",\n \"PropCity\": \"Anytown\",\n \"PropState\": \"VA\",\n \"PropZip\": \"20112\",\n \"PropOwner\": \"John Doe\",\n \"PropDesc\": \"Single family residence\",\n \"Services\": \"\",\n \"UserID\": 9283,\n \"PONumber\": \"PO-001\",\n \"dbaName\": \"Branch or DBA name\",\n \"AccContact\": \"Access contact name\",\n \"AccMobile\": \"555-555-1234\",\n \"AccHome\": \"555-555-5678\",\n \"AccWork\": \"555-555-9012\",\n \"AccEmail\": \"contact@example.com\",\n \"CallbackReference\": \"Your callback reference\",\n \"Notes\": \"Order notes\",\n \"ReportHTML\": \"\",\n \"DocumentsList\": [\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument.pdf\",\n\t\t\t\t\"DocumentType\": \"pdf\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document\",\n\t\t\t\t\"Document\": \"JVBERi0xLjQKJcfsj6I... [Base64]\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"DocumentName\": \"testdocument2.pdf\",\n\t\t\t\t\"DocumentType\": \"PDF\",\n\t\t\t\t\"DocumentNotes\": \"some test notes about this document again\",\n\t\t\t\t\"Document\": \"JVBERi0xLjYNJeLjz9MN...[Base64]\"\n\t\t\t}\n\t\t]\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/exchange/NewDocumentOrder","description":"

Submit one or more new document orders. Same body shape as NewOrders.

Batch-capable order submission endpoints. All accept a JSON array of order objects.

\n","_postman_id":"1702c096-4b42-4f59-a45d-3fd59aabbb37","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}}},{"name":"Account Lookups","item":[{"name":"ClientServices - List account services","id":"7fc2802e-ea76-488c-8639-296ca566389b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://your-nvms-host/exchange/ClientServices","description":"

List the services currently available on your account. No parameters. Results returned in the results field.

List the users on your client account — the source of valid UserID values for order submission. No parameters.

List all currently open jobs on your account. No parameters.

Get the status of a single order. Pass an NVMSJobID or a FileNumber to search. (At least one value is required - NVMSJobID is preferred)

Get order status at the line-item level. Reads NVMSJobID, FileNumber, PONumber.

Get full order details (report data with photo references). Reads NVMSJobID, LineItemID, FileNumber, PONumber. (At least one value is required - NVMSJobID is preferred)

Retrieve the completed order report as a PDF document. Reads NVMSJobID, LineItemID, FileNumber, PONumber. (At least one value is required - NVMSJobID is preferred)

Retrieve all photo attachments for an order. Reads NVMSJobID, LineItemID, FileNumber.

(At least one value is required - NVMSJobID is preferred)

Retrieve raw inspection collection data for an order. Reads NVMSJobID, LineItemID, FileNumber, PONumber. (At least one value is required - NVMSJobID is preferred)

Retrieve shipping addresses. Reads NVMSJobID, FileNumber, ByDate. (At least one value is required - NVMSJobID is preferred)

Query endpoints. All accept a StatusRequest JSON object; only the listed fields are read by each endpoint.

\n","_postman_id":"f1dbe435-fb75-4b69-b285-c63f9f8e1234","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"861e0dce-29b4-46c0-ac4c-881750239164","id":"861e0dce-29b4-46c0-ac4c-881750239164","name":"NVMS Exchange (REST) v2","type":"collection"}}},{"name":"Draw Orders","item":[{"name":"DrawItems - Draw line items","id":"ffe240d8-44df-4330-983f-4a7fae5cb266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NVMSJobID\": 298383\n}","options":{"raw":{"language":"json"}}},"url":"https://your-nvms-host/exchange/DrawItems","description":"

Retrieve the draw line items for a draw order. Reads NVMSJobID.

Retrieve a full export of a draw order. Reads NVMSJobID.

Get the list of job notes for an order. Pass an NVMSJobID or FileNumber to search.

Add a note to an existing order. Reads FileNumber, NVMSJobID, JobNote.

Request cancellation of an order by NVMS job ID. Reads NVMSJobID, CancelNote. This method will send a cancellation request. It doesn't immediately cancel and order.

Request cancellation of an order by file number. Reads FileNumber, CancelNote. This method will send a cancellation request. It doesn't immediately cancel and order.