Livedocs/api-reference/create-order
Create Order
Create a gated document order from a verified company profile.
Create Order
Create Order is the hard revenue gate. It requires a canonical company_profile_id and rejects unverified candidates.
POST
/api/v1/documents/orders/Create a gated order from a verified company profile.
Status
Live
Auth
Session-gated
Credit cost
Plan dependent
Request
company_profile_id is required. discovery_candidate_id is optional audit context.
Request body
{
"company_profile_id": "9f2...",
"discovery_candidate_id": "dc_123",
"document_type": "AD",
"plan_id": "pay-per-doc"
}Response
Returns the order id, status context, and next payment or delivery step.
Response body
{
"id": "ord_123",
"status": "PREVIEW_READY",
"company_profile_id": "9f2...",
"workflow_status": "started"
}Ordering eligibility
- Never pass client-supplied company name/court/registry as canonical order data.
- Only verified company_profile_id can cross the revenue gate.
Code examples
cURL
curl -X POST https://openregis.com/api/v1/documents/orders/ \
-H "Content-Type: application/json" \
-d '{"company_profile_id":"9f2...","document_type":"AD","plan_id":"pay-per-doc"}'Fehler
| Code | Meaning | Client action |
|---|---|---|
| verified_company_required | The selected company is not verified enough for paid ordering. | Send the user back to company search and choose an orderable result. |
| duplicate_order | A duplicate click/order was detected. | Show the existing order instead of creating another. |