Process a document via API

Overview

Often companies need to process documents they receive in other systems in Detected for things like fraud checks, translations or OCR.

These are configured within case management and then can be easily called via API.

General Flow

Create a case to hold the required documents (or skip this if case already exists)

Push the required documents to the case using the library id to trigger the right processing flows

Wait for the webhook confirmation that the documents been processed

Retrieve the full details of the processed document

Integration View

---
config:
  theme: redux-dark
  look: classic
---
sequenceDiagram
  autonumber
  participant ClientBackend as Clients App
  participant DetectedApis as Detected APIs

  ClientBackend ->> DetectedApis: POST /profiles
  DetectedApis -->> ClientBackend: Profile references

  ClientBackend ->> DetectedApis: POST /profiles/{profile-id}/documents/{doc-library-id}
  DetectedApis -->> ClientBackend: 200 OK

  DetectedApis --) ClientBackend: Document processed webhook
  ClientBackend ->> DetectedApis: GET /profiles/{profile-id}/documents/{document-id}
  DetectedApis -->> ClientBackend: Document details

Platform Setup Checklist

Ensure documents have been created in the document library & processing steps selected (OCR, Fraud, Translate)

Fetch the document IDs and store them in your application to use with each API call (using the Retrieve document library types api)

Configure the Document Processing Webhook

Common Questions

Question	Answer
What profile type should be used when i create the profile?	You can use any profile type, it doesn't impact the overall processing.
How do i get the ids of the available document types	Use the Retrieve document library types API to get the IDs of the different documents that are setup in the platform