/
Coral BackEnd API Flow

Coral BackEnd API Flow

Owned by Megha Chandrashekharappa
Last updated: Feb 26, 2025
2 min read

Two endpoints

For each document ready for Redaction, submit a Redaction request.

  • Receives the Document Request

(DocumentId, ServiceType(Redaction/Indexing/Both))

  • Update Queue table to place a hold

    • Indexing In Progress

    • Redaction In Progress

    • Redaction and Indexing In Progress

  • Prepare the request by retrieving document image details

    • "token": "",

    • "fileName": "ML1.pdf", - DocumentImage.ImagePath get name with extension.

    • "category": "State", - Tenant.StateID = State.StateID, get StateName /(Cache)

    • "subCategory": "County", - Tenant.CountyID = County.CountyID, get CountyName / (Cache)

    • "docType": "Deed", - Document.DocuemntTypeID = DocumentType.ID, get DocumentType.Code

    • "serviceType": "Indexing"/"Redaction"/"ALL"

    • "keywords": [],

    • "score": 10 - Setting table

    • "documentImageID": "123", - DocumentImage.Id

    • "imagePath”: "S3 Bucket Path", - DocumentImage.ImagePath

  • Insert into Redact table - Send Request to RedactionIntegrationAPI (Check for existing Record if exists mark the existing one as Deleted by setting columns - “DeleteByUserId“, "DeleteDate", "Deleted")

    • "Id",

    • “DocumentId”

    • "DateSent",

    • "RedactStatus", – Start

    • "CreateByUserId",

    • "CreateDate"

  • Update Redact table - Response from RedactionIntegrationAPI

    • "RedactStatus", - InProgress/Error

    • "Errors",

    • "RedactKey” - (CorrelationID),

    • "ModifyByUserId",

    • "ModifyDate"

 

Receives the redaction result for each Document request.

  • Update Redact table for RedactKey (CorrelationID)

    • "RedactStatus", - Complete/Error

    • “HasRedactions“, - True/False

    • "DateReturned",

    • "Errors",

    • "ModifyByUserId",

    • "ModifyDate"

    • Result JSON - JSON to Redact table

  • Release Hold on the record from Queue table

Indexing Flow @ Coral:

Indexing Flag – N - Tenant doesn't do indexing

Send document to verify queue: Creates a record in Queue table, with QueueType=2 (from the enum)

Indexing Flag – Y – Tenant does Indexing

It Verifies all documents and all de values indexed for the documentType assigned (indexFields & LegalGroup):

  • If all values marked as required for indexing (column isRequiredForIndexing=true) are populated, then the document is sent to verify queue. Creates a record in Queue table, with QueueType=2 (“verify” from the enum)

  • If at least one value marked as required for indexing (column isRequiredForIndexing=true), is not assigned, then the document is sent to indexing queue. Creates a record in Queue table, with QueueType=1 (“index“ from the enum)

  • If all the values from the documentType ( indexFields & LegalGroup) are assigned, (column isRequiredForIndexing=true), then the document is sent to verify queue. Creates a record in Queue table, with QueueType=2 (“verify” from the enum)

 

 

Related content