HomeGuidesRecipesAPI ExplorerForumSupport
Partner Portal
Partner Portal

Manage persons

Learn how to manage the persons responsible for the organization entities.

Suggest Edits

Overview

Entities of type organization can have responsible persons' information associated with them.

📘

Roles and permissions

To use the /persons* endpoints with an entity user token, this entity user must have a role with the person permission.

If using a partner-level token, no special permissions are needed.

Add a person to an entity

To add a person to an entity, call POST /entities/{entity_id}/persons:

curl -X POST 'https://api.sandbox.monite.com/v1/entities/{entity_id}/persons' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "address": {
         "country": "DE",
         "line1": "Flughafenstrasse 52",
         "line2": "Additional information",
         "postal_code": "10115",
         "city": "Berlin",
         "state": "BE"
       },
       "date_of_birth": "1993-03-14",
       "first_name": "Mary",
       "last_name": "O\'Brien",
       "email": "[email protected]",
       "phone": "+4903023125000",
       "relationship": {
         "title": "CEO",
         "representative": false,
         "executive": true,
         "director": false,
         "owner": false,
         "percent_ownership": 10
       },
       "id_number": "NL000099998B57",
       "ssn_last_4": "0001"
     }'

Notes:

  • An entity can have only one relationship.representative.
  • id_number is an optional field required only for NL onboarding for payment acceptance.
  • ssn_last_4 is an optional field required only for US onboarding for payment acceptance

The successful response returns the ID assigned to this person, along with the information passed in the request:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2023-03-14T15:08:12.037Z",
  "updated_at": "2023-03-14T15:08:12.037Z",
  "first_name": "Mary",
  "last_name": "O'Brien",
  ...
}

List all persons

To get information about all persons associated with the specified entity, call
GET /entities/{entity_id}/persons.

Retrieve a person

To get information about a specific person associated with the specified entity, call
GET /entities/{entity_id}/persons/{person_id}.

Edit a person

To edit an existing person of the specified entity, call
PATCH /entities/{entity_id}/persons/{person_id}.

Delete a person

To delete an existing person from the list of persons associated with the specified entity, call
DELETE /entities/{entity_id}/persons/{person_id}.

Updated about 1 month ago