Skip to main content

Create Document Order

Submit an order for one or more legal documents related to a legal entity.

Orders are fulfilled asynchronously. Once the order is completed or cancelled, a webhook notification is sent to the provided callback URL.

Method & URL​

POST https://api.gbris.com/api/document/order

Request Body​

{
  "documents": [
    {
      "entity_persistent_id": "c338d773ad8595ad1e63dc4651854e50",
      "product_code": "DE_GMBH_ANNUAL_REPORT_EN",
      "year": 2023,
      "requirement": "ALLOW_MISSING"
    }
  ],
  "callback_url": "https://yourapp.com/api/callback"
}

Fields​

FieldRequiredTypeDescription
documentsYesarrayOne or more document requests.
documents[].entity_persistent_idYesstringThe entity’s persistent ID, as returned by the entity search endpoint.
documents[].product_codeYesstringThe product code for the requested document (see documents[] in the entity response).
documents[].yearNonumberRequired only for year-specific documents (e.g., annual reports).
documents[].requirementNostringEither ALLOW_MISSING (default) or CANCEL_IF_MISSING. See Requirement Modes.
callback_urlNostringYour system's endpoint for receiving webhook notifications upon order completion or cancellation. See Document Order Webhook.

Example Request​

curl -X POST "https://api.gbris.com/api/document/order" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "entity_persistent_id": "c338d773ad8595ad1e63dc4651854e50",
        "product_code": "DE_GMBH_ANNUAL_REPORT_EN",
        "year": 2023,
        "requirement": "ALLOW_MISSING"
      }
    ],
    "callback_url": "https://yourapp.com/api/callback"
  }'

Example Response​

{
  "order_id": "d8595ad1e63dc",
  "status": "IN_PROGRESS"
}

Requirement Modes​

ModeBehavior
ALLOW_MISSINGIf a document is unavailable, the rest of the order will be fulfilled. The missing document will not be charged. If all documents in an order are ALLOW_MISSING, and none are available, then the order will be cancelled.
CANCEL_IF_MISSINGIf any document is unavailable, the entire order will be cancelled and nothing will be charged.

Notes​

  • Orders are processed asynchronously.
  • The order_id can be used to query order status via GET /document/order/{id}.
  • A webhook will be sent to the callback_url when the order is either completed or cancelled.
    See Document Order Webhook for details.