Entity persons
Learn how to provide information about the key persons of organization-type entities.
Overview
Entities of type organization
that want to use Monite payment rails must provide information about their key persons as part of payments onboarding. The key persons include the primary representative, business owners, directors, and executives.
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
:
Notes:
- An entity can have only one
relationship.representative
. id_number
is an optional field required only for Dutch citizens.ssn_last_4
is an optional field required only for US citizens.
The successful response returns the ID assigned to this person, along with the information passed in the request:
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}
.