{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"93691a5d-a11d-4423-829f-8f52ddbcb27b","name":"Compex Legal API","description":"The **Compex Legal API** is a RESTful interface that enables secure, programmatic access to core Compex services, including the creation and management of Orders and Attachments, real-time status updates through Webhooks, and retrieval of Records.\n\nThis API is designed to streamline legal operations and automate workflows by integrating directly with your internal systems. Whether you're tracking order progress, retrieving records, or handling document uploads, the Compex Legal API provides robust endpoints to support your needs.\n\n---\n\n## 🔑 Getting Started\n\nTo start using the Compex Legal API, you'll need to obtain an **API key**, which serves as your unique credential for accessing all endpoints securely.\n\n#### Requesting an API Key\n\nTo obtain an API key:\n\n- Contact your Compex account representative or support team.\n    \n- Provide relevant information about your organization and integration use case.\n    \n- Once approved, Compex will issue you a secure API key.\n    \n\n> 💡 Keep your API key confidential. It grants access to protected data and operations on your account. \n  \n\nSee the [Authentication](https://go.postman.co/workspace/1e0ecbce-d665-46ba-89b3-dcf8d32a0f30/documentation/43632773-6db68ae2-80ec-4f6c-ac9f-62637e49ef35?entity=folder-f0fddba7-bdb1-4c6f-9f1f-8caa8de18878) section for more details about using your API key to authenticate your API requests.\n\n## Environments\n\nCompex provides two independently isolated environments for client utilization. One intended for testing, and the other for production activity.\n\nHosts\n\n- api.compexlegal.io \\[Production\\]\n    \n- api.test.compexlabs.com \\[Test\\]\n    \n\n## 🧭 What to Expect\n\n#### ➔ Place an Order\n\nWhen you create an order using `POST /v1/orders/order` you will receive an `id` in the response. Save this value so you can connect the status messages you receive via Webhooks. The `id` can be linked to the `source.referenceId` you provided on in the POST body so it is connected in your system.\n\nA new order will begin in a **draft** state. Orders that are in a draft state will not be processed by Compex. The draft state is intended to provide the orderer the opportunity to upload supporting documents as attachments to the order.\n\nOnce you've created the Order, you can upload supporting documents using the `POST /v1/order/orders/{orderId}/attachments` endpoint where `{orderId}` is the `id`.\n\nAfter you have completed uploading any needed documents to Compex, you must identify the order as **ready**. Orders are made ready using the `PATCH /v1/order/orders/{orderId}`endpoint. When updated to ready, Compex will begin processing the order.\n\n#### ➔ Webhook Status Events\n\nAs we process your Order, you will receive Webhook status events. Each Webhook status event will have a `status.id` property that matches the `id` of the Order you created in the previous step.\n\n#### ➔ Download\n\nWhen you receive the `recordDelivered` status event, that's your signal to download the record. To download the record, you can use the `GET /v1/order/orders/{orderId}/records/{recordId}` endpoint. From the `recordDelivered` response body, you will need to use the `status.id` property for `{orderId}` route parameter and `activity.record.id` property for the `{recordId}` route parameter.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"43632773","team":7083617,"collectionId":"93691a5d-a11d-4423-829f-8f52ddbcb27b","publishedId":"2sB2cSgiS1","public":true,"publicUrl":"https://docs.compexlegal.io","privateUrl":"https://go.postman.co/documentation/43632773-93691a5d-a11d-4423-829f-8f52ddbcb27b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00a1d5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/eab6143f-6845-4207-afac-7c6ce0e3225a/Q29tcGV4IFBORyBMb2dvLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"00A1D5"}},{"name":"light","logo":"https://content.pstmn.io/eab6143f-6845-4207-afac-7c6ce0e3225a/Q29tcGV4IFBORyBMb2dvLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00a1d5"}}]}},"version":"8.11.4","publishDate":"2025-06-18T00:07:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/eab6143f-6845-4207-afac-7c6ce0e3225a/Q29tcGV4IFBORyBMb2dvLnBuZw==","logoDark":"https://content.pstmn.io/eab6143f-6845-4207-afac-7c6ce0e3225a/Q29tcGV4IFBORyBMb2dvLnBuZw=="}},"statusCode":200},"environments":[{"name":"Production","id":"0cdf31bc-4706-4042-aacf-1f7620876644","owner":"43631990","values":[{"key":"api.key","value":"<ENTER_KEY>","enabled":true,"type":"secret"},{"key":"orderId","value":"1","enabled":true,"type":"default"},{"key":"env.url","value":"api.compexlegal.io","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c822a83cbc3bf7bb207028fdf2724da0a2ed77cd1ca06fe98c254d65cb1387ea","favicon":"https://compexlegal.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"43631990-0cdf31bc-4706-4042-aacf-1f7620876644"}],"canonicalUrl":"https://docs.compexlegal.io/view/metadata/2sB2cSgiS1"}