Entities

Overview

Entities represent the customers of Monite API partners and can be either organizations or individuals (persons).

An entity registers its operations and stores financial documents (such as payables or bank transactions) via the partner's applications. Those financial documents are in turn stored and processed by Monite.

Create an entity representing your customer

To create a new entity, call POST /entities. The partner-level token is required for this action.

In the example below, the entity is created as an individual:

curl -X POST 'https://api.sandbox.monite.com/v1/entities' \
     -H 'X-Monite-Version: 2023-02-07' \
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "type": "individual",
       "email": "[email protected]",
       "address": {
         "country": "DE",
         "city": "Berlin",
         "state": "BE",
         "postal_code": "10115",
         "line1": "Flughafenstrasse 52"
       },
       "individual": {
         "first_name": "Bob",
         "last_name": "Jones",
         "tax_id": "1234567890"
       }
     }'

The successful response contains the entity created as an individual:

{
  "address": {
    "country": "DE",
    "city": "Berlin",
    "state": "BE",
    "postal_code": "10115",
    "line1": "Flughafenstrasse 52",
    "line2": null
  },
  "email": "[email protected]",
  "partner_reference": null,
  "phone": null,
  "created_at": "2022-04-21T14:23:01.691982+00:00",
  "id": "aea39c7e-630f-4664-a449-de899ebd4912",
  "logo": null,
  "status": "active",
  "updated_at": "2022-04-21T14:23:01.691994+00:00",
  "type": "individual",
  "individual": {
    "first_name": "Bob",
    "last_name": "Jones",
    "vat_id": null,
    "tax_id": "1234567890",
    "title": null
  }
}

To create the entity as an organization, change the following parameters in the request body:

{
  ...
  "type": "organization",
  "organization": {
    "legal_name": "string",
    "vat_id": "string",
    "legal_entity_id": "string"
  }
  ...
}

Once the entity is created, you must provide its bank accounts information.

Update the logo of an entity

You can update the logo of a specific entity. The image can be PNG or JPG up to 10 MB in size.

To update the logo of an entity, call PUT /entities/{entity_id}/logo:

curl -X PUT 'https://api.sandbox.monite.com/v1/entities/{entity_id}/logo' \
     -H 'X-Monite-Version: 2023-02-07' \
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
     -H 'Content-Type: multipart/form-data' \
     -F '[email protected];type=image/png'

The successful response contains information about the new logo:

{
  "id": "c5f499a7-19ea-4057-9191-112da7effa31",
  "created_at": "2022-09-08T00:20:04.961397",
  "file_type": "entity-logo",
  "name": "upload",
  "region": "eu-central-1",
  "md5": "7537d5833741469a03162ce7a73bd4e8",
  "mimetype": "image/jpeg",
  "url": "https://monite-file-saver-entity-logo-eu-central-1.s3.com/image.jpg",
  "size": 1691,
  "previews": [],
  "pages": []
}

List all entities

To get information about all the entities managed by the partner, call GET /entities.

Edit an entity

To edit an existing entity, call PATCH /entities/{entity_id}.

Retrieve an entity

To get information about a specific entity, call GET /entities/{entity_id}.

📘
Learn more about entities, entity users, and the Monite account structure.