Order Document Confirm API

The Order Document Confirm API should be called to complete the process of ordering documents selected in the Order Document Preview API. UniCourt will call a Document Order Completion Webhook on successful completion of document download from the Court for each document ordered.

API URL:

https://api.unicourt.com/rest/v1/orderDocuments/confirm?token=a0f9770a842da247694673196ae2c9549f172526

Request:

Method CURL Command
POST curl -i -k -X POST https://api.unicourt.com/rest/v1/orderDocuments/confirm?token=a0f9770a842da247694673196ae2c9549f172526 --data "order_id=9af58cdf321529737588-409"

Request Query Parameters:

Parameter Parameter Type Required Description
token String Yes Token which is generated in UniCourt Account, for authorizing the request

Request Post Parameters:

Field Name Data Type Required Description
order_id string Yes Specify order_id which you got from Order Preview.

Sample Response

{  
      "order_id":"9af58cdf321529737588-409",
      "invoice_number":null,
      "invoice_amount":null,
      "order_status":"Invoice Pending",
      "order_status_type":"Processing",
      "order_date":"2018-06-23 07:06:28",
      "ordered_document_status":{  
         "CA_LA_1638602390":{  
            "status":"Download In Progress",
            "message":""
         }
      }
}

List of Order Status:

  • Property name order_status
Status Name Description
Awaiting Order Order is yet to be confirmed.
Invoice Pending Order is confirmed by the user and invoice is not yet generated.
Invoice Posted Invoice is generated and not yet collected.
Paid Invoice is paid.
Past Due Invoice payment failed and is in past due.
Cancelled Order is cancelled.

List of Order Status Types:

  • Property name order_status_type
Status Name Description
Preview Order status type will be in Preview untill the invoice is generated.
Processing Order status type will be in Processing once the invoice is generated.
Complete Order status type will be in Complete when the invoice amount is collected.

List of Document Status:

  • Property name status
Status Name Description
Download Not Started Document download from the Court in not yet started. Unless the Order status type is Complete a document will always be in this status.
Download In Progress Document is being downloaded from the Court.
Download Completed Document is successfully downloaded from the Court.
Download Failed Document download from the court is failed.

Get started today

Sign Up Now