Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB
Customers

Create a Customer

Creates a customer object to easily track and store documents.

post/customers

Request body

namestring required

A unique name that was given to the customer by you.

approvedboolean

Set the value true if you have approved the customer, false if you have rejected the customer. The default is null.

notesstring

Additional notes that you want to record about this customer.

Example request

{
  "name": "Frank Abagnale",
  "review": {
    "status": "REJECTED",
    "reason": "FRAUD",
    "comment": "Rejected due to suspected fraudulent activity"
  },
  "notes": "John is a new customer",
  "persons": [
    {
      "first_name": "Frank",
      "last_name": "Abagnale",
      "date_of_birth": "1994-12-31",
      "address": {
        "line_1": "742 Evergreen Terrace",
        "line_2": "Springfield",
        "city": "Springfield",
        "post_code": "62704",
        "state": "IL",
        "country": "USA"
      },
      "email": "frank.abagnale@example.com",
      "phone_number": "+353 85 123 4567",
      "id_number": "078-05-1120"
    }
  ],
  "company": {
    "name": "Acme Inc",
    "address": {
      "line_1": "742 Evergreen Terrace",
      "line_2": "Springfield",
      "city": "Springfield",
      "post_code": "62704",
      "state": "IL",
      "country": "USA"
    },
    "id_number": "01-1234567",
    "structure": "CORPORATION",
    "phone_number": "+1 415 555 0123",
    "website_url": "https://acme.example.com",
    "source_of_funds_claim": "Revenue from product sales"
  },
  "verify_entity": {
    "income": {
      "personal_income": {
        "lower_income_tolerance": 0.1,
        "under_reported_tolerance": 0.1,
        "input": 10000,
        "frequency": "annual"
      },
      "revenue": {
        "lower_income_tolerance": 0.1,
        "under_reported_tolerance": 0.1,
        "input": 50000,
        "frequency": "annual"
      }
    }
  }
}

Response

Successfully created a new customer.

idstring uuid

Unique identifier for the object.

namestring required

A unique name that was given to the customer by you.

created_atstring date-time

Time at which the object was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ

approvedboolean nullable

Has the value false if you have identified the customer as fraudulent, true is legitimate, and null if unknown. The default is null.

notesstring nullable

Additional notes that you have recorded about this customer.

no_of_documentsinteger

A whole number representing the number of documents attached to this customer.

no_of_fraudulent_documentsinteger

A whole number representing the number of attached documents that have been identified as fraudulent.

fraud_rating'HIGH_RISK' | 'LOW_RISK' | 'UNCERTAIN_RISK' | 'null' nullable

The fraud rating of the customer. This field can be either 'HIGH_RISK', 'LOW_RISK', 'UNCERTAIN_RISK', or null. More information can be found at https://help.inscribe.ai/en/articles/8631969-fraud-rating

Example response

{
  "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "name": "Frank Abagnale",
  "created_at": "2019-12-12T15:35:08.460Z",
  "approved": true,
  "review": {
    "status": "REJECTED",
    "reason": "FRAUD",
    "comment": "Rejected due to suspected fraudulent activity"
  },
  "notes": "Pay stub references Acme Inc, which appears as inactive in multiple business registries.",
  "no_of_documents": 3,
  "no_of_fraudulent_documents": 1,
  "urls": {
    "web_app": "https://app.inscribe.ai/#/customer/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
    "api": "https://api.inscribe.ai/api/v2/customers/0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b"
  },
  "creator": {
    "id": "dca9cbb0-d41a-408b-8fd1-99af7e10bf87",
    "email": "mary.johnson@fraudchecker.com",
    "type": "USER"
  },
  "organisation": {
    "id": "15ee827f-2a76-42de-b8b8-36f11430f5a2"
  },
  "risk_assessment": {
    "id": "1d5d7a72-7a89-4e3f-9b14-2a3c1c86bbb0",
    "status": "FINISHED",
    "started_at": "2026-04-09T15:35:08.460Z",
    "finished_at": "2026-04-09T15:36:12.120Z",
    "risk_level": "HIGH",
    "summary": "High risk assessment due to company status showing as inactive across multiple verification sources.",
    "insights": [
      {
        "type": "COMPANY_EXISTENCE",
        "result": "FAIL",
        "title": "Existence of Acme Inc",
        "rationale": "Company appears as inactive or dissolved in multiple business registries and verification sources.",
        "urls": [
          "https://example.com/business-registry/123",
          "https://example.com/company-verification/456"
        ],
        "scopes": [
          "FRAUD"
        ],
        "target": "COMPANY",
        "sub_insights": [
          {
            "type": "WEBSITE_PRESENCE",
            "title": "Website Presence",
            "result": "PASS",
            "rationale": "A website for this company exists.",
            "urls": [
              "https://example.com/sub-insight-source"
            ]
          }
        ],
        "owner_name": "John Doe"
      }
    ]
  },
  "persons": [
    {
      "first_name": "Frank",
      "last_name": "Abagnale",
      "date_of_birth": "1994-12-31",
      "address": {
        "line_1": "742 Evergreen Terrace",
        "line_2": "Springfield",
        "city": "Springfield",
        "post_code": "62704",
        "state": "IL",
        "country": "USA"
      },
      "email": "frank.abagnale@example.com",
      "phone_number": "+353 85 123 4567",
      "id_number": "078-05-1120"
    }
  ],
  "company": {
    "name": "Acme Inc",
    "address": {
      "line_1": "742 Evergreen Terrace",
      "line_2": "Springfield",
      "city": "Springfield",
      "post_code": "62704",
      "state": "IL",
      "country": "USA"
    },
    "id_number": "01-1234567",
    "structure": "CORPORATION",
    "phone_number": "+1 415 555 0123",
    "website_url": "https://acme.example.com",
    "source_of_funds_claim": "Revenue from product sales"
  },
  "verify_entity": {
    "income": {
      "personal_income": {
        "lower_income_tolerance": 0.1,
        "under_reported_tolerance": 0.1,
        "input": 10000,
        "frequency": "annual",
        "verified": true,
        "matched": 10000
      },
      "revenue": {
        "lower_income_tolerance": 0.1,
        "under_reported_tolerance": 0.1,
        "input": 50000,
        "frequency": "annual",
        "verified": true,
        "matched": 49000
      },
      "confidence_score": 0.99
    }
  },
  "canonical_profile": {
    "individual": {
      "name": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "address": {
        "full_address": "1000 Walnut St, Kansas City, MO 64106, USA",
        "city": "Kansas City",
        "state": "MO",
        "country": "USA",
        "post_code": "64106",
        "source": "DOCUMENT"
      },
      "employer": {
        "name": {
          "value": "Acme Inc",
          "source": "DOCUMENT"
        },
        "address": {
          "full_address": "1000 Walnut St, Kansas City, MO 64106, USA",
          "city": "Kansas City",
          "state": "MO",
          "country": "USA",
          "post_code": "64106",
          "source": "DOCUMENT"
        }
      }
    },
    "company": {
      "legal_name": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "address": {
        "full_address": "1000 Walnut St, Kansas City, MO 64106, USA",
        "city": "Kansas City",
        "state": "MO",
        "country": "USA",
        "post_code": "64106",
        "source": "DOCUMENT"
      },
      "phone_number": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "company_structure": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "associated_persons": [
        {
          "full_name": {
            "value": "Acme Inc",
            "source": "DOCUMENT"
          },
          "address": {
            "full_address": "1000 Walnut St, Kansas City, MO 64106, USA",
            "city": "Kansas City",
            "state": "MO",
            "country": "USA",
            "post_code": "64106",
            "source": "DOCUMENT"
          },
          "role": {
            "value": "Acme Inc",
            "source": "DOCUMENT"
          }
        }
      ],
      "source_of_funds_claim": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "business_type": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "business_description": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "ownership_structure": {
        "description": "Acme Inc is wholly owned by John Doe.",
        "rationale": "Company filings list John Doe as the sole shareholder.",
        "related_inscribe_document_ids": [
          "3616baa9-9caf-434e-b4d0-8a32c644dfd4"
        ],
        "source": "DOCUMENT"
      },
      "website": {
        "value": "Acme Inc",
        "source": "DOCUMENT"
      },
      "registry_data": {
        "url": "https://corporatedatastore.com/companies/us_de/12345",
        "name": "Acme Inc",
        "jurisdiction_code": "us_de",
        "company_type": "CORPORATION"
      }
    }
  },
  "business_compliance_agent_v1": {
    "run_id": "1234567",
    "customer_id": "07f1fe87-dece-4a46-915f-3dc3fa8d57fa",
    "status": "FINISHED",
    "started_at": "2024-11-18T15:31:39.759Z",
    "finished_at": "2024-11-18T15:32:32.452Z",
    "output": {
      "result": "PASS",
      "analysis": "The company appears to be legitimate based on our comprehensive review. It has a valid incorporation status, strong web presence, and no adverse media findings.",
      "canonical_profile": {
        "legal_name": "Acme Corporation",
        "address": "123 Main Street, Suite 100, San Francisco, CA 94105",
        "address_city": "San Francisco",
        "address_state": "CA",
        "address_country": "United States",
        "phone_number": "+1 (555) 123-4567",
        "company_structure": "CORPORATION",
        "business_type": "Professional, Scientific, and Technical Services",
        "business_description": "Software development company specializing in financial technology solutions",
        "ownership_structure": "Privately held company with 3 major shareholders",
        "beneficial_owners": [
          {
            "full_name": "John Smith",
            "address": "456 Oak St, San Francisco, CA 94105",
            "address_city": "San Francisco",
            "address_state": "CA",
            "address_country": "United States",
            "role": "CEO"
          }
        ],
        "source_of_funds_claim": "Revenue from software licensing and professional services",
        "opencorporates_data": {
          "name": "Acme Corporation",
          "company_type": "Corporation"
        }
      },
      "company_checks": [
        {
          "type": "INCORPORATION_STATUS",
          "title": "Incorporation Status",
          "sub_checks": [
            {
              "type": "INCORPORATION_STATUS_FROM_WEB",
              "title": "Incorporation Status from Web",
              "result": "PASS",
              "rationale": "Found evidence of proper incorporation from web sources.",
              "urls": [
                "https://example.org/verification"
              ],
              "related_inscribe_document_ids": []
            }
          ],
          "result": "PASS",
          "rationale": "The check passed based on verified information from reliable sources.",
          "urls": [
            "https://example.com/verification"
          ],
          "related_inscribe_document_ids": [
            "42"
          ]
        }
      ],
      "beneficial_owner_checks": [
        {
          "beneficial_owner_full_name": "John Smith",
          "checks": [
            {
              "type": "CONNECTION_TO_COMPANY",
              "title": "Connection to Company",
              "sub_checks": [
                {
                  "result": "PASS",
                  "rationale": "The check passed based on verified information from reliable sources.",
                  "urls": [
                    "https://example.com/verification"
                  ],
                  "related_inscribe_document_ids": [
                    "42"
                  ]
                }
              ],
              "result": "PASS",
              "rationale": "The check passed based on verified information from reliable sources.",
              "urls": [
                "https://example.com/verification"
              ],
              "related_inscribe_document_ids": [
                "42"
              ]
            }
          ]
        }
      ]
    }
  }
}