Capabilities

entities.merge

Changed on

Merge multiple legal entities into one. Reassigns all linked documents to the kept entity, adds merged entity names as aliases, and deletes the duplicates.

post/capabilities/entities.merge

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/entities.merge
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

keepEntityIdstring required

ID of the legal entity to keep as the canonical record

mergeEntityIdsKeepEntityId[] required(unresolved $ref)

IDs of legal entities to merge into the kept entity. Their names become aliases and linked documents are reassigned.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes