NotaryLive API - Order Status

Getting Order Status

You may need to check the status of an order to see if it has been completed, or get the finalized documents. Depending on the way you integrated with NotaryLive, you may provide your own order ID or use the whitelabel token to get the order status.

Below is an example of how to get the status of an order using the order ID:

curl -X POST "https://notarylive.com/api/v2/order/status" \
    -H 'Content-Type: application/json' \
    -u 'api_test_user:api_test_key' \
    -d $'{"order_id":"((internal_order_id))"}'

Below is an example of how to get the status of an order using the whitelabel token:

curl -X POST "https://notarylive.com/api/v2/order/status" \
    -H 'Content-Type: application/json' \
    -u 'api_test_user:api_test_key' \
    -d $'{"whitelabel_token":"((whitelabel_token))"}'

A successful request will generate the following response:

{
  "success": 1,
  "status": "notarized",
  "document_urls": [
    "https://notarylive.com/sfl/..."
  ]
}

---

Status Definitions

The following are the possible status definitions for an order:

Status	Description
incomplete	The session has not been completed.
paid	The session has been paid for.
notarized	The session has been completed. | Response will include document_urls with the URLs to the notarized documents.
canceled	The session has been canceled.

---

Validation Failures

Invalid credentials will return a 401 response with the message: HTTP/1.0 401 Unauthorized

Invalid or missing payload data will return a 400 HTTP response with a JSON body containing success = 0 as well as an array of errors containing both a standardized error code, as well as a human-readable description of what caused the error:

If you continue having issues, please take a look at our troubleshooting guide.

curl -X POST "https://notarylive.com/api/v2/order/status" \
    -H 'Content-Type: application/json' \
    -u 'api_test_user:api_test_key' \
    -d $'{}'

{
  "success": 0,
  "errors": [
    {
      "code": "no_identifier_submitted",
      "message": "This endpoint requires either a nl_order_id, a order_id or a whitelabel_token parameter to identify the order"
    }
  ]
}

---

Changelogs

For a list of changes to this api endpoint, please see the changelog.

---

Copyright © 2024, NotaryLive.com