API Reference

Person update

post
https://sandbox.mipisepaymentservices.com/api/platforms//users//persons/

Modifies the data of a person.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the platform.

uuid
required

The unique identifier of the user.

uuid
required

The unique identifier of the person.

Body Params

Add the person's fields you want to modify in the 'person' object.

Object with all possible fields in a person, regardless of its specifications.

string
enum

Type of the person.

  • Persons::Natural → Individual
  • Persons::Legal → Solo proprietor, Company, or Association
Allowed:
string
enum

Range of most recent annual income

string

Country in which the NATURAL person was born OR country in which the LEGAL person is registered - by ISO 3166-1 alpha-2 format

string
enum

Estimated wealth of the NATURAL person / Equity of the LEGAL person

boolean

Indicates whether the related (1) tax country of the person is their main one

boolean

Indicates whether the related (2) tax country of the person is their main one

boolean

Indicates whether the related (3) tax country of the person is their main one

string

Reason why the person has no tax number for their first tax country - ONLY if tin_code_1 is null

string

Reason why the person has no tax number for their first tax country - ONLY if tin_code_2 is null

string

Reason why the person has no tax number for their first tax country - ONLY if tin_code_3 is null

string

Indicates any unlisted legal source of the person's funds, only if no available option fits on the source_of_funds attribute

string
enum

Indicates the primary source of the person's funds

string

Tax country (1) of the person - by ISO 3166-1 alpha-2 format ; REQUIRED if either the associated tin_code_1 or no_tin_reason_1 is not null

string

Tax country (2) of the person - by ISO 3166-1 alpha-2 format ; REQUIRED if either the associated tin_code_2 or no_tin_reason_2 is not null

string

Tax country (3) of the person - by ISO 3166-1 alpha-2 format ; REQUIRED if either the associated tin_code_3 or no_tin_reason_3 is not null

string

Tax Identification Number of the person in the related (1) tax country - REQUIRED if the associated tax_country_code_1 is not null ; can be replaced with the associated no_tin_reason_1

string

Tax Identification Number of the person in the related (2) tax country - REQUIRED if the associated tax_country_code_2 is not null ; can be replaced with the associated no_tin_reason_2

string

Tax Identification Number of the person in the related (3) tax country - REQUIRED if the associated tax_country_code_3 is not null ; can be replaced with the associated no_tin_reason_3

string

First name of the person - NATURAL only

string

Last name of the person - NATURAL only

string

City in which the natural person was born - NATURAL only

date

Birth date of the person - NATURAL only

string
enum

Only required if the natural person was born in the USA, Mexico or Canada : Province in which the natural person was born - NATURAL only

enum

Civility of the person - NATURAL only

Allowed:
string

Phone number of the natural person (including country code) - NATURAL only

string

French PCS-2020 classification code of the natural person's professional situation - NATURAL only

integer
enum

Business category - LEGAL only

  • 0 = Solo proprietor
  • 1 = Company (all types)
  • 2 = Association (churches included)
Allowed:
string

Business entity name - LEGAL only

string

The french INSEE (legal classification code) of the legal person - LEGAL only

string

The french INSEE (activity classification code) of the legal person - LEGAL only

date

Registration date of the legal person - LEGAL only

string

French RCS registration number of the legal person (can replace rna) - LEGAL only

string

French RNA registration number of the legal person (can replace registration_number) - LEGAL only

string

Nationality of the person - by ISO 3166-1 alpha-2 format

address
object

Object for address creation - Required for KYC/KYB

role_data
object

Object for a natural person creation with role

persons
array of objects

List of persons linked to the legal entity - LEGAL only

persons
boolean

Indicates if the person is the user representative - One NATURAL only

boolean

Indicates whether the person's relationship with the platform is intermediated by a third party. Required to validate the user's wallet.

fatca_crs_data
object

FATCA/CRS compliance data. Fields available depend on the person type:

  • Persons::Natural accepts us_citizen_or_resident.
  • Persons::Legal accepts the FATCA/CRS classification fields below.
    All fields are optional at this stage; they will be required for KYC/KYB in a future release.
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?