Get Notarization

This endpoint retrieves the details of a notarization case

GET /v1/notarization/{case_id}

Request

--request GET 'https://api.beglaubigt.de/v1/notarization/123e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer <token>'

{
  "response": {
      "result": "success",
      "message": "Case fetched successfully.",
      "case_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "in-progress",
      "url": "https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000",
      "documents": [
          {
              "status": "completed",
              "original_document_id": "123e4567-e89b-12d3-a456-426614174001",
              "original_document_url": "https://app.beglaubigt.de/download?bucket=documents&id=123e4567-e89b-12d3-a456-426614174001&token=b4n...omL",
              "notarized_document_id": "123e4567-e89b-12d3-a456-426614174002",
              "notarized_document_url": "https://app.beglaubigt.de/download?bucket=notarized_documents&id=123e4567-e89b-12d3-a456-426614174002&token=u5K...m1C"
          }
      ],
      "signers": [
          {
              "first_name": "John",
              "last_name": "Doe",
              "email": "[e-mail]",
              "url": "https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000?token=123e4567-e89b-12d3-a456-426614174003"
          }
      ],
      "client_reference": "REF-2024-001"
  }
}

Authorization

To authenticate requests, include an Authorization header with a Bearer token:

Authorization: Bearer <token>

Example: Bearer sk-123e4567-e89b-12d3-a456-426614174000

Path Parameters

case_id · string · required

The unique identifier of the notarization case to retrieve.
Example: 123e4567-e89b-12d3-a456-426614174000

Response

result · string

Indicates the outcome of the API request.
Possible values: success or error

message · string

Provides a human-readable message detailing the result of the API request.
Exemple: Case created successfully.

case_id · string

The unique identifier for the created notarization case in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000

status · string

The current status of the notarization request.
Possible values: in-progress or completed

url · string

A unique, case-specific URL for accessing and monitoring the current status and details of the notarization process.
Example: https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000

documents · array

List of documents included in this notarization request.

Show Documents Response Object

status · string

Indicates the current processing state of the specific document within the notarization case.
Possible values: draft, signatures-requested, waiting-for-verifications, notarization-started or completed

original_document_id · string

The unique identifier for the original document associated with the case in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000

original_document_url · string

The URL of the original document associated with the case in a PDF format. The URL is available for 24 hours after the request.
Example: https://app.beglaubigt.de/download?bucket=documents&id=123e4567-e89b-12d3-a456-426614174000&token=a1H...To5

notarized_document_id · string

The unique identifier for the notarized version of the document associated with the case in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174001

notarized_document_url · string

The URL of the notarized document associated with the case in a PDF format. The URL is available for 24 hours after the request.
Example: https://app.beglaubigt.de/download?bucket=notarized_documents&id=123e4567-e89b-12d3-a456-426614174001&token=h4J...f7P

signers · array

List of signers included in this notarization request.

Show Signers Response Object

first_name · string

The first name of the signer.

last_name · string

The last name of the signer.

email · string

The email address of the signer.

url · string

A unique invitation link containing an identification token. The link prompts the signer to complete the required actions, such as signing or verifying documents, based on the notarization requirements.\

Example: https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000?token=123e4567-e89b-12d3-a456-426614174001

client_reference · string

The custom client reference string provided when creating the case though the API POST request.\

Example: REF-2024-001

Request

--request GET 'https://api.beglaubigt.de/v1/notarization/123e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer <token>'

{
  "response": {
      "result": "success",
      "message": "Case fetched successfully.",
      "case_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "in-progress",
      "url": "https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000",
      "documents": [
          {
              "status": "completed",
              "original_document_id": "123e4567-e89b-12d3-a456-426614174001",
              "original_document_url": "https://app.beglaubigt.de/download?bucket=documents&id=123e4567-e89b-12d3-a456-426614174001&token=b4n...omL",
              "notarized_document_id": "123e4567-e89b-12d3-a456-426614174002",
              "notarized_document_url": "https://app.beglaubigt.de/download?bucket=notarized_documents&id=123e4567-e89b-12d3-a456-426614174002&token=u5K...m1C"
          }
      ],
      "signers": [
          {
              "first_name": "John",
              "last_name": "Doe",
              "email": "[e-mail]",
              "url": "https://app.beglaubigt.de/notarize/123e4567-e89b-12d3-a456-426614174000?token=123e4567-e89b-12d3-a456-426614174003"
          }
      ],
      "client_reference": "REF-2024-001"
  }
}