NotaryLive API - Order Status

Return to NotaryLive
Return to NotaryLive

Documentation

Endpoints

eSign API

IPEN API

Page last updated: August 6, 2026

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/v3/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/v3/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",
  "detailed_status": "notarized",
  "document_urls": [
    "https://notarylive.com/sfl/..."
  ],
  "document_ids": [
    "deed-of-trust",
    "grant-deed"
  ]
}

document_ids is included when the order was created with the document_ids parameter. The array order matches document_urls (first entry corresponds to first document).

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.

Detailed Status

Orders created on API v3 also include a supplementary detailed_status field alongside status. Where status reports the high-level lifecycle stage, detailed_status reports the customer's granular progress through the session: hardware checks, identity verification, the lobby, and the live session. For orders with multiple signers, detailed_status reflects the primary signer's progress.

The current possible values are below. Additional values may be introduced over time as the session flow evolves, so we recommend handling unrecognized values gracefully.

Detailed Status Description
created The order has been created but the customer has not yet started.
hardware_not_checked The customer is in the pre-session steps; their hardware has not yet been checked.
hardware_failed The customer's hardware (camera/microphone) check failed.
hardware_passed The customer's hardware check passed.
identity_passed_id / identity_failed_id ID document verification passed or failed.
identity_passed_biometrics / identity_failed_biometrics Biometric (selfie) verification passed or failed.
identity_passed_kba / identity_failed_kba Knowledge-based authentication (KBA) passed or failed.
identity_expired The customer's identity verification expired and must be redone.
entered_lobby The customer has reached the lobby where they can be connected to a notary.
entered_session The customer has entered a live session with a notary.
redirected_hardware During the session, the notary sent the customer back to the hardware check.
redirected_id During the session, the notary sent the customer back to the identity/ID step.
redirected_documents During the session, the notary sent the customer back to the document step.
redirected_signers During the session, the notary sent the customer back to the signers/witnesses step.
redirected_lobby During the session, the notary sent the customer back to the lobby.
notarized The session has been completed and the documents notarized.
declined The notary declined the notarization.
deleted The order was deleted and is no longer available.

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/v3/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 © 2026, NotaryLive.com