API Documentation
Use the CollateralXP API to access orders, notes, order files, request revisions, and more, and seamlessly integrate your product into the workflows of your collateral management platform.
Getting started
To get started, create an API key in your profile, then read about how to request the resources you need to access using our HTTP APIs or dedicated client SDKs. Next, you'll work on our staging environment. Finally, start reaching the live API endpoint when your integration is ready to go live.
Resources
Client configurations
Retrieve your client configuration and use it for requesting orders.
Orders
Learn about the orders resource and all the options you have when you request an order.
Order assignments
Accept or reject orders assigned to you.
Inspections
Manage inspections for orders assigned to you.
Payments
Get information about order items/payments.
Notes
Notes are the resource to back and forward communication about an order.
Submissions
Learn about how to submit order files.
Files
Learn about how to upload, remove, and retrieve order files.
Revisions
Quickly request revisions and revisions of value.
Completions
Rquest orders completions.
Fulfillments
Rquest orders fulfillments.
Parties
Handle orders parties.
Negotiations
Accept and refuse negotiations initiated by AMCs.
Company
Endpoints and information scoped to the company/organization.
Me
Get information about the current user as well as JWT for SSO.