(Document ver. 3.0.1)
\nUse the ECG Partner Portal API endpoints to create a new Submission (with or without owner(s)). Owner(s) and document(s) can be subsequently added to a Submission. A document can also be returned with an optional note in response to an ECG communication request for additional information.
\nIn addition, the following endpoints can be used to query results for a Submission. A query can be sent to return details for a single or multiple Submissions as well as returning the following details:
\nECG maintains separate URL endpoints for Development (testing), Preview (pre-production), and Production (live production).
\nDevelopment URL - https://api.dev.ecg.com
\nUse the provided Development Token and Development URL endpoint to send Submissions to the ECG Development environment. This environment is strictly for testing purposes only. These Submissions will NOT be worked and offers will NOT be submitted. We do not guarantee that data submitted to this environment will be retained for longer than one week.
\nPreview URL - https://api.preview.ecg.com
\nUse the provided Production Token and Preview URL endpoint to send Submissions to the ECG Preview environment. This environment uses production data with pre-production code. Any data submitted to this environment will be worked as if it were production data.
\nProduction URL - https://api.prod.ecg.com
\nUse the provided Production Token and Production URL endpoint to send Submissions to the ECG Production environment. This environment uses both production data and production code. Any data submitted to this environment will be worked.
\nUse this API to:
\nRefer to Tips for Using Postman for instructions on where to insert your ECG Token.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5947704","collectionId":"c212fc36-5c6c-4c8f-ab38-eeee02bb4367","publishedId":"S1TN829S","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-15T15:42:14.000Z"},"item":[{"name":"Add Submission-V1","item":[{"name":"Add Submission-V1 (No Owners)","event":[{"listen":"test","script":{"id":"cd242aa6-766c-4b12-a593-df9fc27da591","exec":["pm.test(\"Lead added successfully\", function () {"," pm.response.to.have.status(201);","});","pm.test(\"ISO Rep-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.partner_rep).to.eql(\"Test Rep\");","});","pm.test(\"ISO Email-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.partner_email).to.eql(\"TestRep@notreal.com\");","});","pm.test(\"Bus Name-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.name).to.eql(\"TEST ABC COMPANY LLC\");","});","pm.test(\"Bus DBA-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.dba).to.eql(\"TEST ABC COMPANY'S STORE\");","});","pm.test(\"Bus EIN-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.tax_id).to.eql(\"126666666\");","});","pm.test(\"Bus Industry-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.industry).to.eql(\"Restaurant & Bar Establishments\");","});","pm.test(\"Bus Street-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.street).to.eql(\"100 N MAIN\");","});","pm.test(\"Bus City-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.city).to.eql(\"SIOUX FALLS\");","});","pm.test(\"Bus State-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.state).to.eql(\"SD\");","});","pm.test(\"Bus Zip-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.zip).to.eql(\"57105\");","});","pm.test(\"Bus Phone1-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.phone).to.eql(\"3205550011\");","});","pm.test(\"Bus Email (optional)-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.email).to.eql(\"TEST@NOTANEMAIL.COM\");","});","pm.test(\"Bus Phone2 (optional)-added successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.phone2).to.eql(\"1116665555\");","});","pm.test(\"Bus Start Date-added successfully\", function () {"," pm.expect(pm.response.text()).to.include(\"2001-10-31T00:00:00+00:00\");","});"],"type":"text/javascript"}}],"id":"faf7dfd9-fad5-40b8-b280-7a0e414f3105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Enter required information to add a Submission without any owners.
\n*See the Partner Portal API Documentation Appendix for the full Submission Schema and a complete list of accepted values.
\n","urlObject":{"protocol":"https","path":["api","v1","submissions"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"0624a593-6fed-4d75-a023-e0c3619f7513","name":"Submission Added with No Owners (Pass Code 201)","originalRequest":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Enter required information to add a Submission with up to two owners.
\n*See the Partner Portal API Documentation Appendix for the full Submission Schema and a complete list of accepted values.
\n","urlObject":{"protocol":"https","path":["api","v1","submissions"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"3f5745ee-57a9-4285-aa89-78f068a732e8","name":"Missing Required Owner Info-Bus Added-Owner Not Added (Pass Code 207)","originalRequest":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Enter required information to add a Submission with up to two owners.
\n*See the Partner Portal API Documentation Appendix for the full Submission Schema and a complete list of accepted values.
\n","urlObject":{"protocol":"https","path":["api","v2","submissions"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"81d40bab-c6cd-4712-8889-a60639f18804","name":"Error-Invalid Required Bus Info-Submission Not Added (Error Code 400)","originalRequest":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"A Submission can be added without owners or with up to two owners. See the Partner Portal API Documentation Appendix for the complete Submission Schema.
\n","event":[{"listen":"prerequest","script":{"id":"14ada2be-a30b-4722-b625-a6d5fee0a71e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96396f1b-38e5-427f-b59c-54aebed010fe","type":"text/javascript","exec":[""]}}],"_postman_id":"4def49b4-f4e9-4b94-a1bb-7d8b1b7c8c0f"},{"name":"Add Owner","item":[{"name":"Add Owner(s)","event":[{"listen":"prerequest","script":{"id":"a836cf06-7934-42cc-9501-8befae2a6359","exec":["pm.variables.set(\"submission_id\", \"386919\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"93795b9a-618d-469c-89da-2298d701118a","exec":["pm.test(\"Owner was successfully added\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Owner 1 First Name\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].first_name).to.eql(\"GEORGE\");","});","pm.test(\"Owner 1 Last Name\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].last_name).to.eql(\"JETTSON\");","});","pm.test(\"Owner 1 Ownership %\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].ownership_percentage).to.eql(51);","});","pm.test(\"Owner 1 Street\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].street).to.eql(\"200 MAIN AVE\");","});","pm.test(\"Owner 1 City\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].city).to.eql(\"SIOUX FALLS\");","});","pm.test(\"Owner 1 State\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].state).to.eql(\"SD\");","});","pm.test(\"Owner 1 Zip\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].zip).to.eql(\"57105\");","});","pm.test(\"Owner 1 Phone1\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].phone).to.eql(\"8885956211\");","}); ","pm.test(\"Owner 1 Email\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].email).to.eql(\"GEORGE@NOTANEMAIL.COM\");","}); ","pm.test(\"Owner 1 SSN\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].ssn).to.eql(\"111444367\");","}); ","pm.test(\"Owner 1 DOB\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.owners[0].dob).to.eql(\"1980-10-31\");","});"],"type":"text/javascript"}}],"id":"4112ac95-0472-434e-acea-22e85d1d7778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Specify a Submission ID and enter the required information to add 1 or 2 owners to the Submission. A Submission can have up to 2 owners.
\nSee the Partner Portal API Documentation Appendix for the full Submission Schema.
\n","urlObject":{"protocol":"https","path":["api","v1","submissions","{{submission_id}}","owners"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"1d822892-09f1-45a5-91e1-9a9872d2252a","name":"Error-Submission ID is Locked-Owner Not Added (Error Code 423)","originalRequest":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Owner(s) can be subsequently added to a Submission. A Submission can have up to 2 owners. See the Partner Portal API Documentation Appendix for the complete Submission Schema.
\n","event":[{"listen":"prerequest","script":{"id":"a3e2dc9f-d17d-4f45-8aa5-8457c2ce2cb4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e4d83b8e-a0fd-4385-b436-fb70c7fd5705","type":"text/javascript","exec":[""]}}],"_postman_id":"377586aa-92ca-481f-9aff-016f8c0429b5"},{"name":"Add Document","item":[{"name":"Add Document","event":[{"listen":"prerequest","script":{"id":"d292e86b-889f-41aa-9c9d-4288a8e9253d","exec":["pm.variables.set(\"submission_id\", \"413058\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"d4a3ee05-81f5-42d6-958b-8a8bc46204a1","exec":["pm.test(\"File was successfully added\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"9d90cab2-679e-43e0-82b8-6d9f187cddea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Required - Enter the file name for the document.
\n"},{"key":"file","type":"file","description":"Click Select Files to browse for a file to upload
\n","src":"/C:/Users/klewin.ECG/Downloads/CAloanVarcheck.pdf"},{"key":"note","value":"This is my doc uploaded from Postman","description":"Optional - Enter a note to descript the document
\n","type":"text"},{"key":"tag","value":"Signed Application","description":"Optional - Enter a predefined document tag. See API Doc Appendix.
\n","type":"text"}]},"url":"https://api.dev.ecg.com/api/v1/submissions/{{submission_id}}/documents","description":"*See the Partner Portal API Documentation Appendix for the full Submission Schema.
\n","urlObject":{"protocol":"https","path":["api","v1","submissions","{{submission_id}}","documents"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"0eb048fd-129a-4788-b96a-d2bcf84162e3","name":"Error-Submission is Locked-Doc Not Added (Error Code 423)","originalRequest":{"method":"POST","header":[{"key":"x-authtoken","type":"text","value":"Documents can be subsequently added to a Submission. See the Partner Portal API Documentation Appendix for the complete Submission Schema.
\n","event":[{"listen":"prerequest","script":{"id":"0cc968b8-6807-46fc-b3c6-ae76cdd73951","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7fa7af4c-b440-43ce-a736-c5f5de19830e","type":"text/javascript","exec":[""]}}],"_postman_id":"a58dead0-6cbe-4ece-8d05-a1da40baeab4"},{"name":"Get Submission Details","item":[{"name":"Get Single Submission Details-V2","event":[{"listen":"prerequest","script":{"id":"fe363fa9-77d1-413f-abe8-e5801ef2775b","exec":["pm.variables.set(\"submission_id\", \"403699\");"],"type":"text/javascript"}},{"listen":"test","script":{"id":"53ecd410-97e6-4d7b-8e0b-eb8828315ee9","exec":["pm.test(\"Lead Submission Details Returned\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"5f17c6b1-c382-4ad5-9c64-9d46064e350e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-authtoken","value":"Specify a Submission ID to return ISO, business, owner details, and status for a Submission.
\n*See the Partner Portal API Documentation Appendix for the full Submission Schema and a complete list of accepted values.
\n","urlObject":{"protocol":"https","path":["api","v2","submissions","{{submission_id}}"],"host":["api","dev","ecg","com"],"query":[],"variable":[]}},"response":[{"id":"052365e8-620e-4cc3-bbd4-744f550d374f","name":"Single Submission 2 Owners-Details Docs Notes & Offers Returned (HAL+JSON) (Pass Code 200)","originalRequest":{"method":"GET","header":[{"key":"x-authtoken","value":"Specify parameters to return ISO, business and owner details for all Submissions that meet the specified parameters.
\nSelect the appropriate parameters to filter the list of returned submissions:
\n*See the Partner Portal API Documentation Appendix for the full Submission Schema and a complete list of accepted values.
\n","urlObject":{"protocol":"https","path":["api","v1","submissions"],"host":["api","dev","ecg","com"],"query":[{"disabled":true,"description":{"content":"Optional: Starting date (YYYY-MM-DD): Returns all submissions posted since that date
\n","type":"text/plain"},"key":"since","value":"2021-01-01"},{"disabled":true,"description":{"content":"Optional: Ending date (YYYY-MM-DD): Returns all submissions posted through that date
\n","type":"text/plain"},"key":"end","value":"2020-12-15"},{"disabled":true,"description":{"content":"Optional: Search Type (leadid, dba, address1, phone, ownerlast, loanid, status, documents & messages)
\n","type":"text/plain"},"key":"type","value":"leadid"},{"disabled":true,"description":{"content":"Optional: Query - Enter criteria to filter the returned submissions
\n","type":"text/plain"},"key":"q","value":"410767"},{"description":{"content":"Optional: Page # - Enter the page number to return if pagination is used
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional: Number of items per page if pagination is used
\n","type":"text/plain"},"key":"items","value":"10"}],"variable":[]}},"response":[{"id":"a01b49be-23a2-4b8d-8de0-6a27a3005f1b","name":"Multiple Submissions Details Returned (HAL+JSON) (Pass Code 200)","originalRequest":{"method":"GET","header":[{"key":"x-authtoken","value":"Specify a Submission ID to return the Submission Status. See the Partner Portal API Documentation Appendix for a complete listing of Submission Statuses.
\nSpecify a Submission ID to return details for document(s) uploaded for a Submission.
\nSpecify a Submission ID to return Submission Notes.
\nSpecify a Submission ID to return the current offer details for that Submission.
\nNOTE: The Buy Rate is calculated by taking the Sell Rate less the Commission.
\nSpecify a Submission ID to return the current contract details for that Submission.
\nThe Submission Details requests are used to return various details regarding the Submission or Submissions. See the Partner Portal API Documentation Appendix for the complete Submission Schema.
\n