Get Registry Document

Returns a short-lived presigned URL for downloading one document Lissom retrieved from the company registry (currently Companies House). Use the id from registry_documents on Get Application or on the application.registry_documents_fetched webhook.

GET /api/external/applications/{id}/registry-documents/{docId}

Authentication

Requires an API key with applications:read scope. The application must belong to the organization associated with the API key.

Authorization: Bearer klara_{client_id}.{secret}

Path parameters

string

required

UUID of the application.

string

required

UUID of the registry document.

Response

Returns 200 OK with a presigned download URL.

string

Presigned S3 URL valid for 60 seconds. Use this to download the file directly.

string

File name of the stored filing.

string

MIME type of the file (application/pdf).

string

Filing type. See Registry document types.

string | null

Date the document was filed with the registry (YYYY-MM-DD).

Examples

curl "https://app.klara-ai.com/api/external/applications/550e8400.../registry-documents/880e8400..." \
  -H "Authorization: Bearer klara_abc123def456.your-secret-here"

curl -o incorporation.pdf "https://s3.amazonaws.com/..."

const response = await fetch(
  'https://app.klara-ai.com/api/external/applications/550e8400.../registry-documents/880e8400...',
  {
    headers: {
      'Authorization': 'Bearer klara_abc123def456.your-secret-here'
    }
  }
);

const { url, file_name } = await response.json();

const fileResponse = await fetch(url);
const fileBuffer = await fileResponse.arrayBuffer();

import requests

response = requests.get(
    'https://app.klara-ai.com/api/external/applications/550e8400.../registry-documents/880e8400...',
    headers={'Authorization': 'Bearer klara_abc123def456.your-secret-here'}
)

data = response.json()

file_response = requests.get(data['url'])
with open(data['file_name'], 'wb') as f:
    f.write(file_response.content)

Response:

{
  "url": "https://s3.amazonaws.com/bucket/org-id/applications/app-id/registry/NEWINC-MzI4NjQ5.pdf?X-Amz-...",
  "file_name": "NEWINC-MzI4NjQ5.pdf",
  "file_type": "application/pdf",
  "document_type": "NEWINC",
  "filing_date": "2020-05-01"
}

Download URLs expire after 60 seconds. Download the file immediately, or call this endpoint again for a fresh URL.

Errors

Status	Error	Cause
`401`	`Invalid API key`	API key is invalid, expired, or inactive
`401`	`API key missing required scopes: applications:read`	Key lacks the required scope
`404`	`Application not found`	Application does not exist or belongs to a different organization
`404`	`Document not found`	Document does not exist, belongs to another application, was not retrieved, or the application is not registry-eligible
`500`	`Internal server error`	An unexpected error occurred

Overview

Applications

Reference

Get Registry Document

Authentication

Path parameters

Response

Examples

Errors

​Authentication

​Path parameters

​Response

​Examples

​Errors

Authentication

Path parameters

Response

Examples

Errors