Retrieve signed document

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

A single request can be associated with a document with multiple signatures from the same requester.

Therefore, it is possible to retrieve the signed documents by starting from a request, then accessing the signature details, and finally, the URL where the file is available.

This API call enables you to retrieve the signed documents associated with an identification for a specific request.

Endpoint

• URL: /request/{id}/signatures
• Method: GET

Headers

Ensure you include the following headers in your request:

• Accept: application/json
• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Path parameters

• id (required): The ID of the request for which you want to retrieve identifications. Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

• includeUrlValidBefore(required)
  Datetime the URL to retrieve the signed document expires (max 5 days from the request).
  Example: 2025-04-06T23:59:59.00000Z

Example cURL API call

curl --location 'https://test-eu-ie1-api.namirialonboarding.com/api/v2/request/{id}/signatures?includeUrlValidBefore={datetime}' \
--header 'Accept: application/json' \
--header 'X-Api-Key: YOUR_API_KEY'

Replace YOUR_API_KEY with your actual API key and YOUR_REQUEST_ID with the ID of the request.

Responses

• 200 OK

  • Example Response:

    {
        "content": [
            {
                "id": "8e412d2d-f431-46e1-aad5-5915bfee1d02",
                "signedAt": "2025-04-05T21:39:07.878378Z",
                "method": "RemoteSignatureLongLivedDisposableCertificate",
                "pageMode": "headless",
                "plainResource": {
                    "id": "62380d1c-355c-48aa-a19b-7b722fc86547",
                    "filename": "NamirialOnboarding.pdf",
                    "mimeType": "application/pdf",
                    "name": "Document To Sign",
                    "type": "CONTRACT_DOCUMENT",
                    "subType": "DOCUMENT_FLATTENED",
                    "family": "DOCUMENT_TO_SIGN",
                    "metadata": {
                        "sourceTemplateUrl": "https://namirial.com/NamirialOnboarding.pdf"
                    },
                    "resourceUri": "{value}",
                    "resourceUrl": "{url}",
                    "urlValidBefore": "2025-04-06T23:59:59Z",
                    "sizeBytes": 138890,
                    "status": "AVAILABLE"
                },
                "signedResource": {
                    "id": "beb9949b-af23-49b7-9d63-772c78c971e1",
                    "filename": "NamirialOnboarding.pdf",
                    "mimeType": "application/pdf",
                    "type": "CONTRACT_DOCUMENT",
                    "family": "SIGNED_DOCUMENT",
                    "metadata": {
                        "fileId": "2e7f6aa6-a444-4fe3-9ddc-b1dc531d5c96",
                        "workstep": "91858E09091CE14C1E033053E5D1EEC06E675C1A59EA59DD552E87FDD4461DA8112D2906ABA9F703E23583FF56980A43"
                    },
                    "resourceUri": "{value}",
                    "resourceUrl": "{url}",
                    "urlValidBefore": "2025-04-06T23:59:59Z",
                    "sizeBytes": 207541,
                    "status": "AVAILABLE"
                }
            }
        ]
    }

‌