v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Documents

Upload Document(s)

Uploads document(s) to a customer. Once the document(s) are uploaded, they will be queued for processing by Inscribe's fraud detection, parsing, and optionally verification algorithms. The file size limit is 50 MB and the page limit for PDFs is 350.

post/customers/{customer_id}/documents

Path parameters

customer_idstring uuid required

The Inscribe customer id.

Response

Successfully uploaded.

Example response

{
  "data": [
    {
      "uuid": "6e764ab5-4617-40d5-9076-0bd0e537b4d1",
      "id": "42",
      "name": "john_smith_payslip_dec20.pdf",
      "created_at": "2019-12-12T15:35:08.460Z",
      "customer_id": "684502aa-268a-4c2a-b166-ac4bfa2caf44",
      "customer_name": "John Smith",
      "state": "PROCESSED",
      "total_pages": 1,
      "document_type": "BANK_STATEMENT",
      "subtypes": [
        "CP_575"
      ],
      "file_type": "TRUE_PDF",
      "language": "en",
      "is_fraudulent": true,
      "trust_score": 50,
      "quality_score": 50,
      "review_status": "ACCEPTED",
      "review": {
        "status": "REJECTED",
        "reason": "FRAUD",
        "comment": "Rejected due to suspected fraudulent activity"
      },
      "urls": {
        "web_app": "https://app.inscribe.ai/#/customer/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/document/1234",
        "api": "https://api.inscribe.ai/api/v2/customers/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b/documents/1234",
        "original_file": "https://production-us-west-2-assets.inscribeusercontent.com/files/users/123/documents/8a2d3b0c-27be-4513-91ab-52c6e0a19691_document.png"
      },
      "risk_assessment": {
        "summary": "This document has been flagged as high risk due to the presence of several fraud signals, as well as concerns about the legitimacy of the seller.",
        "insights": [
          {
            "type": "INVOICE_SELLER_EXISTENCE",
            "result": "FAIL",
            "title": "Existence of ABC Company Ltd.",
            "rationale": "Unable to verify the existence of the seller 'ABC Company Ltd.' through business registries and online presence checks.",
            "urls": [
              "https://businessregistry.example.com/search?q=abc-company-ltd"
            ]
          }
        ]
      }
    }
  ]
}