API FAQs



  • What fields are included in the API?
    • Answer: Please visit our API Fields and Descriptions, HERE.


  • What if I don’t see the data field, I need in the API Documentation?
    • Answer: Then the data field is not available via API.


  • How do I integrate with my Salesforce and/or Encompass system?
    • Answer: Your developers can engineer solutions with the available documentation. 


  • Why am I getting 401 Unauthorized error? Error message { "statusCode": 401, "message": "Unauthorized. Access token is missing or invalid." }
    • Answer: If you are receiving a 401 response, either the web token is invalid, or your account is not authorized for that API. Please see the Credential Authentication “Workflow OAUTH 2.0.pdf” available HERE. This document was sent to your designated contact with your initial credentials. The combination of the client_id, client_secret, and resource when making the authorization request will determine what is included in the returned token. You can verify by copying the JWT. Be sure the values you were provided upon registration are correct in your request (usually starting with “eyJ0eXA…”) into a tool like https://jwt.io/ and examine the contents. There you will see the “roles” granted to your client_id. These roles correspond to the APIs to which you’ve been given access.


  • Does your API allow for Webhook capabilities?
    • Answer: We currently do not support webhooks from our Comergence APIs – we only support a pull model; however, we are considering adding it to our list of improvements. Thank you for expressing your interest.


  • How often is the API data updated?
    • Answer: The API data is transactional and up to date with Comergence.com. Third Party Data providers (for example, NMLS) update as frequently as the data source allows.


  • Where do I find the endpoint URL information?
    • Answer: Please refer to the Digital Marketplace HERE for API Documentation.


  • Do you have a test environment or sandbox?
    • Answer: Given the nature of the data we do not provide a test system. You are free to use a third-party API development tool (example, Postman) to access your own data. The “TRY IT” functionality on the developer portal may not function as expected for all end points as it is tied to a test account with limited data.
    • Please Note: The "Try It" feature does not work with the NMLS Verification API as the dataset is live. 


  • For the “GET Customer Document File” call. What types of documents are returned?
    • Answer: The document types returned are all those allowed by our upload functionality which is currently restricted to doc, docx, xls, xlsx and pdf. The maximum size is 20 MB.


  • What is determined an "Ongoing Relationship" and "Active Relationship"?
    • Answer: Active relationship and ongoing relationships are defined as clients that have been approved (Active) and have not yet been terminated. 
    • Please Note: Does not include Cancelled, Terminated, and Declined Clients.