Get Lead Documents - OmniAI Docs

const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<your-api-key>',
  },
};

fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/documents`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

lead_id = '4ef30123-90c2-4dc0-bd28-b43eee8664ea'
url = f"https://api-v2.getomni.ai/api/v1/leads/{lead_id}/documents"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads/4ef30123-90c2-4dc0-bd28-b43eee8664ea/documents \
  --header 'x-api-key: <your-api-key>'

[
  {
    "id": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
    "filename": "vital-checking-june-25.pdf",
    "mimeType": "application/pdf",
    "size": 153143,
    "metadata": {
      "extractionStatus": "completed",
      "Matched checklist items": [
        {
          "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
          "label": "Bank Statements"
        }
      ]
    },
    "signedUrl": "https://omniai-server-v2-prod.s3.us-east-2.amazonaws.com/...",
    "leadChecklistItemDocument": [
      {
        "id": "0e66ab12-af87-4dbc-956a-2063b4ecb552",
        "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
        "documentId": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
        "overallValid": true,
        "validationResult": {
          "otherNotes": "",
          "overallValid": true,
          "validationResults": [
            {
              "isValid": true,
              "ruleName": "Files must be business bank statements",
              "isValidReason": "The document is a business bank statement..."
            }
          ]
        }
      }
    ]
  }
]

GET

api

leads

{leadId}

documents

const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<your-api-key>',
  },
};

fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/documents`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

lead_id = '4ef30123-90c2-4dc0-bd28-b43eee8664ea'
url = f"https://api-v2.getomni.ai/api/v1/leads/{lead_id}/documents"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads/4ef30123-90c2-4dc0-bd28-b43eee8664ea/documents \
  --header 'x-api-key: <your-api-key>'

[
  {
    "id": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
    "filename": "vital-checking-june-25.pdf",
    "mimeType": "application/pdf",
    "size": 153143,
    "metadata": {
      "extractionStatus": "completed",
      "Matched checklist items": [
        {
          "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
          "label": "Bank Statements"
        }
      ]
    },
    "signedUrl": "https://omniai-server-v2-prod.s3.us-east-2.amazonaws.com/...",
    "leadChecklistItemDocument": [
      {
        "id": "0e66ab12-af87-4dbc-956a-2063b4ecb552",
        "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
        "documentId": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
        "overallValid": true,
        "validationResult": {
          "otherNotes": "",
          "overallValid": true,
          "validationResults": [
            {
              "isValid": true,
              "ruleName": "Files must be business bank statements",
              "isValidReason": "The document is a business bank statement..."
            }
          ]
        }
      }
    ]
  }
]

This endpoint fetches all documents associated with a specific lead.

Path Parameters

leadId

string

required

The unique identifier of the lead

Response

documents

array

Array of document objects

Show documents

string

Unique identifier for the document

filename

string

Original filename of the document

mimeType

string

MIME type of the document (e.g., “application/pdf”, “image/jpeg”)

size

number

File size in bytes

signedUrl

string

Pre-signed URL for accessing the document (expires after 1 hour)

metadata

object

Document metadata including processing status

Show metadata

extractionStatus

string

Status of the extraction (e.g., “completed”)

Matched checklist items

array

Array of checklist items this document is matched to

Show Matched checklist items

leadChecklistItemId

string

ID of the matched checklist item

label

string

Label of the matched checklist item

leadChecklistItemDocument

array

Array of checklist item document associations with validation results

Show leadChecklistItemDocument

string

Unique identifier for the checklist item document association

leadChecklistItemId

string

ID of the checklist item this document is associated with

documentId

string

ID of the document

overallValid

boolean

Whether the document passed overall validation

validationResult

object

Detailed validation result for the document

Show validationResult

otherNotes

string

Additional notes about the validation

overallValid

boolean

Whether the document passed overall validation

validationResults

array

Array of individual validation rule results

Show validationResults

isValid

boolean

Whether this validation rule passed

ruleName

string

Name of the validation rule

isValidReason

string

Reason explaining why the rule passed or failed

Signed URLs expire after 1 hour. Use Get Document API to get a fresh signed URL.

const leadId = '4ef30123-90c2-4dc0-bd28-b43eee8664ea';
const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<your-api-key>',
  },
};

fetch(`https://api-v2.getomni.ai/api/v1/leads/${leadId}/documents`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

lead_id = '4ef30123-90c2-4dc0-bd28-b43eee8664ea'
url = f"https://api-v2.getomni.ai/api/v1/leads/{lead_id}/documents"
headers = {
    "x-api-key": "<your-api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

curl --request GET \
  --url https://api-v2.getomni.ai/api/v1/leads/4ef30123-90c2-4dc0-bd28-b43eee8664ea/documents \
  --header 'x-api-key: <your-api-key>'

[
  {
    "id": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
    "filename": "vital-checking-june-25.pdf",
    "mimeType": "application/pdf",
    "size": 153143,
    "metadata": {
      "extractionStatus": "completed",
      "Matched checklist items": [
        {
          "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
          "label": "Bank Statements"
        }
      ]
    },
    "signedUrl": "https://omniai-server-v2-prod.s3.us-east-2.amazonaws.com/...",
    "leadChecklistItemDocument": [
      {
        "id": "0e66ab12-af87-4dbc-956a-2063b4ecb552",
        "leadChecklistItemId": "fb6c17f3-4d7e-4979-a262-9c287ae0e6dd",
        "documentId": "4fa0d0de-6958-4d1f-9468-ebb8629eae8c",
        "overallValid": true,
        "validationResult": {
          "otherNotes": "",
          "overallValid": true,
          "validationResults": [
            {
              "isValid": true,
              "ruleName": "Files must be business bank statements",
              "isValidReason": "The document is a business bank statement..."
            }
          ]
        }
      }
    ]
  }
]

Get Lead Checklist Get Lead Action Logs

​Path Parameters

​Response

Path Parameters

Response