Update Person

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

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
Array of objects or null (PersonIdentificationDTO)

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.

person_guid
string <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 or null

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

email
string or null

Valid email address of the person.

first_name
string or null <= 32 characters

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

middle_name
string or null <= 32 characters

Person’s middle name.

last_name
string or null <= 32 characters

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.

object or null

Any additional information about the person in a key-value format.

mobile_number
string or null

Person’s mobile phone number.

home_number
string or null

The Person’s home phone number.

office_number
string or null

The Person’s office phone number.

object (AddressDTO)

Address details

object (AddressDTO)

Address details

object (AddressDTO)

Address details

nationality
string or null <= 3 characters

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

ip_address
string or null

The IP Address of the person who is registering

person_status
string (PersonStatus)

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.

Enum: "INCOMPLETE" "UNVERIFIED" "CLEARED" "SANCTIONED" "PEP" "NEGLIST" "ANONYMOUS" "POTENTIALMATCH"
client_reference_id
string or null

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

verfication_mode
string or null

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

verfication_level
string or null

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

person_forget_mode
string or null

To be skipped in request.For future use.

person_forget_mode_date
string or null

To be skipped in request.For future use.

market_notification_optin
string or null

To be skipped in request.For future use.

market_notification_optin_date
string or null

To be skipped in request.For future use.

address_lat
number <double>

To be skipped in request.For future use.

address_lon
number <double>

To be skipped in request.For future use.

contact_type
string or null
profile_dd_mode
string or null

Related to the Due Diligence mode applied for the Person. To be skipped in request. For future use.

request_code
string or null

To be skipped in request.

wallet_id
string or null

To be skipped in request.

title
string or null

Title used by the Person

mask_govt_id_number
string or null

To be skipped in request.

comments
string or null

Client specified comment for the Person.

jurisdiction_state
string or null [ 2 .. 32 ] characters

Jurisdiction state for the Person.Can be used to send state of incorporation for CORPORATE type Person.

jurisdiction_country
string or null 3 characters

Jurisdiction country for the Person. Can be used to send country of incorporation for CORPORATE type Person.

beneficial_ownership
number or null <double> [ 0 .. 100 ] ^\d+(\.\d{1,2})?$

Beneficial Owner % Stake - Percentage stake of the person in a company. Applicable if a BENEFICIALOWNER type person is being created for an entity/company.

Array of objects or null (PersonRelation)

List of related persons

mask_account_number
string or null <= 19 characters

Masked bank account number.

ledger_balance
number <double>

Ledger balance (also called Account balance). This include funds that are authorized, but not yet cleared.

Responses
200

Returns the updated Person

400

Bad request

401

Unauthorized

500

Server Error

put/api/{version}/persons
Request samples
application/json
{
  • "identifications": [
    • {
      • "govt_id_type": "NOTPROVIDED",
      • "govt_id_number": "string"
      }
    ],
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "birth_date": "string",
  • "email": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "additional_data": {
    • "property1": "string",
    • "property2": "string"
    },
  • "mobile_number": "string",
  • "home_number": "string",
  • "office_number": "string",
  • "base_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "mailing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "billing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "nationality": "str",
  • "ip_address": "string",
  • "person_status": "INCOMPLETE",
  • "client_reference_id": "string",
  • "verfication_mode": "string",
  • "verfication_level": "string",
  • "person_forget_mode": "string",
  • "person_forget_mode_date": "string",
  • "market_notification_optin": "string",
  • "market_notification_optin_date": "string",
  • "address_lat": 0,
  • "address_lon": 0,
  • "contact_type": "string",
  • "profile_dd_mode": "string",
  • "request_code": "string",
  • "wallet_id": "string",
  • "title": "string",
  • "mask_govt_id_number": "string",
  • "comments": "string",
  • "jurisdiction_state": "string",
  • "jurisdiction_country": "str",
  • "beneficial_ownership": 100,
  • "person_relations": [
    • {
      • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
      • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
      • "person_relationship": "string",
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "sys_utcupdated": "2019-08-24T14:15:22Z"
      }
    ],
  • "mask_account_number": "string",
  • "ledger_balance": 0
}
Response samples
application/json
{
  • "identifications": [
    • {
      • "govt_id_type": "NOTPROVIDED",
      • "govt_id_number": "string"
      }
    ],
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "birth_date": "string",
  • "email": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "additional_data": {
    • "property1": "string",
    • "property2": "string"
    },
  • "mobile_number": "string",
  • "home_number": "string",
  • "office_number": "string",
  • "base_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "mailing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "billing_address": {
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "nationality": "str",
  • "ip_address": "string",
  • "person_status": "INCOMPLETE",
  • "client_reference_id": "string",
  • "verfication_mode": "string",
  • "verfication_level": "string",
  • "person_forget_mode": "string",
  • "person_forget_mode_date": "string",
  • "market_notification_optin": "string",
  • "market_notification_optin_date": "string",
  • "address_lat": 0,
  • "address_lon": 0,
  • "contact_type": "string",
  • "profile_dd_mode": "string",
  • "request_code": "string",
  • "wallet_id": "string",
  • "title": "string",
  • "mask_govt_id_number": "string",
  • "comments": "string",
  • "jurisdiction_state": "string",
  • "jurisdiction_country": "str",
  • "beneficial_ownership": 100,
  • "person_relations": [
    • {
      • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
      • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
      • "person_relationship": "string",
      • "sys_utcinserted": "2019-08-24T14:15:22Z",
      • "sys_utcupdated": "2019-08-24T14:15:22Z"
      }
    ],
  • "mask_account_number": "string",
  • "ledger_balance": 0
}
Copyright © Qolo 2019-2023. All right reserved.