Get a session
Read session state, outbound activity, and audit information.
Overview
Retrieve the current session projection and associated activity. Use this operation to reconcile webhook-driven state or investigate an interrupted workflow. The result is not a complete copy of the create-session request.
The session must belong to the vendor associated with the API key. Use the returned BlueNotary session ID, not your notarization_id.
- Find the session ID
Look up the BlueNotary ID associated with your order.
- Read current state
Inspect session_doc and any stage information.
- Reconcile your system
Apply the current state without repeating already-completed side effects.
Parameters
| Field | Requirement | Description |
|---|---|---|
bn_session_idstring · path | Required | The 24-character BlueNotary session identifier returned by Create Session. |
Request example
Use a server-side API key. Replace example IDs and values before using this request in an approved test environment.
curl --request GET \
--url 'https://app.bluenotary.us/api/integrationsv2/sessions/YOUR_SESSION_ID' \
--header "Authorization: Bearer $BLUENOTARY_API_KEY"Response
200 · Example success Illustrative values in the current response shape.
{
"session_doc": {
"_id": "69a100000000000000001042",
"status": "unsigned",
"signingType": "ron",
"notorizationType": "Acknowledgement",
"createdAt": "2030-01-15T14:45:00.000Z",
"updatedAt": "2030-01-15T14:45:00.000Z"
},
"all_outbound_vendor_logs": [],
"audit_logs": []
}session_doc.status, completion-processing markers, billing outcomes, and webhook event names are different concepts.- The optional
session_completion_reportcontains a named Base64 report when available. Signed session PDFs use the separate signed-documents operation. - Staged eSign sessions may return
current_stageandstages. A stage completion is not necessarily final session completion. - Use bounded reconciliation alongside webhooks. No universal polling interval is specified; choose a bounded schedule appropriate to the workflow and account limits.
Errors & recovery
| Status | What happened | What to do |
|---|---|---|
| 400 | Invalid session ID format | Use the exact returned bn_session_id. |
| 401 | Authentication failed | Check the API key and its expiry. |
| 403 | Session Not Found | Confirm the session exists, is not deleted, and belongs to this vendor. |
Explore the response
Response simulator
LOCAL EXAMPLEExplore the example response without an API key. This does not send requests or validate your account configuration.
This example uses the resource ID shown in the endpoint path.
Reading the response
Expect a resource-shaped response rather than a common success envelope.
session_doc: a selected set of session fields including status, signing type, timestamps, and payment-related information.all_outbound_vendor_logs: recorded outbound activity for this session.audit_logs: available audit entries. Treat participant information as sensitive.session_completion_report: optional object with name, base64Doc, and initial_document_name.