Update Person

put

https://devapi.qolopay.com/api/{version}/persons

This end point will allow you to update a person information on the Qolo platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

person_guid

uuid

Person's unique identifier to be sent only if the person is already created on the platform. If person_guid is passed, all other person details in the API request will be skipped. On the other hand, person_guid must not be passed if a new person/accountholder/cardholder is being created. .

birth_date

string | null

Person’s date of birth. (For businesses - date of incorporation). Required for compliance due diligence.
Accepted Format: yyyy-MM-dd

string | null

Valid email address of the person.

first_name

string | null

Person’s first name.Mandatory if person_guid is not passed and the when the person type is an INDIVIDUAL

middle_name

string | null

Person’s middle name.

last_name

string | null

Person’s last name. Mandatory if person_guid is not passed. Additionally, if the person type is CORPORATE, the entire business name must be sent as last_name.

additional_data

object | null

Any additional information about the person in a key-value format. Must include complete value that will be saved in database.

mobile_number

string | null

Person’s mobile phone number.

home_number

string | null

The Person’s home phone number.

office_number

string | null

The Person’s office phone number.

base_address

object

Address details

mailing_address

object

Address details

billing_address

object

Address details

nationality

string | null

Nationality of the person in ISO 3-letter country code.

ip_address

string | null

The IP Address of the person who is registering

person_status

string

enum

Status of the person identifying if they are cleared for card creation and transaction or if they are blocked for certain reasons. Ties in to the Person Verification result. Can be skipped if program identifies the person status as per the program requirements. Possible values are:

INCOMPLETE - When person verification is not yet complete and pending for some more details.
UNVERIFIED - Person has failed verification.
CLEARED - Person has cleared the verification requirement for the program.
SANCTIONED - Person name found in sanctioned list.
PEP - Person name found in PEP list.
NEGLIST - Person name found in Negative list.
ANONYMOUS - Person details are not provided.
POTENTIALMATCH - Person name has a match with the OFAC/Sanction list.
This has to be passed as "CLEARED" for PROGRAMPERSON contact_type.

identifications

array of objects | null

List of identification details of the Person. Required for electronic or manual verification. Skip if your program does not require KYC verification or you do not have the need to capture such information on the platform.

identifications

client_reference_id

string | null

API Partner can send the person's unique id on their system.

verfication_mode

string | null

Mode of verification used for the Person. To be skipped in request. For future use.

verfication_level

string | null

Verification level of the Person. To be skipped in request. For future use.

This has to be passed as "KYC_NA" for PROGRAMPERSON contact_type.

person_forget_mode

string | null