Corporate Update

Consumer can be updated either by a Partner, or directly by the Enduser himself.

Information update

PATCH Consumer endpoint should be used to change different Consumer informations : external Id, email address, phone number, address, source of funds, other source of funds, occupation, other occupation, last terms accepted.

After updating the email address or the phone number if it was previously "VERIFIED", the new one will have to be verified again, using the dedicated endpoint :

Last Terms and Conditions accepted

One important Update the have in mind is the "lastTermsAccepted" field :
Indeed, if a new version of the Terms and Conditions is released, Consumer has to accept these before using banking features again.
Please refer to the Terms & Conditions Guide page for more information

Here is the Request Body of the Consumer Udpate endpoint :

Request Body schema: application/json
externalId
string [ 0 .. 511 ] characters

A unique identifier that you can use to link this consumer to a user in your system.

object (AddressRequestDto)
emailAddress
string
sourceOfFunds
string
Enum: "COMPENSATION_PAYOUT" "COMPANY_PROFITS" "COMPANY_SALE" "DIVIDEND_PAYMENTS" "DIVORCE_SETTLEMENT" "FIXED_DEPOSITS" "GIFT" "INHERITANCE" "INSURANCE_PAYOUT" "LOAN" "LOTTERY_OR_GAMBLING_WIN" "RETIREMENT_INCOME" "SALE_OF_INVESTMENT" "SALE_OF_PROPERTY" "SAVINGS_FROM_SALARY" "OTHER"
otherSourceOfFunds
string [ 0 .. 511 ] characters

Description of source of funds if 'OTHER' was chosen.

occupation
string

The consumer usual or principal work or business as a means of earning a living.

Enum: "BUSINESS_OWNER" "CLERGY" "CRAFTSMAN" "ENGINEER" "EXECUTIVE" "FARMER" "FREELANCE" "LIBERAL_PROFESSION" "POLITICIAN" "PROFESSOR" "PUBLIC_SERVANT" "RETIRED" "SHOPKEEPER" "STUDENT" "UNEMPLOYED" "WORKER" "OTHER"
otherOccupation
string [ 0 .. 511 ] characters

Description of occupation if 'OTHER' was chosen.

lastTermsAccepted
string

The version of the terms and conditions signed by the consumer.

object (Metadata)

A custom field to save data.

This field's size is limited to 3000 characters.

application/json
{
  • "externalId": "string",
  • "address": {
    },
  • "emailAddress": "string",
  • "sourceOfFunds": "COMPENSATION_PAYOUT",
  • "otherSourceOfFunds": "string",
  • "occupation": "BUSINESS_OWNER",
  • "otherOccupation": "string",
  • "lastTermsAccepted": "1.0",
  • "metadata": {
    }
}

Other information

If you want to change information for example as usage name, please contact your customer care.

If you want to change Enduser personal information for example your last name, you will have to perform another KYC under conditions.

Suspend a Corporate

A corporate can be suspended, using the "Suspend an end-user" endpoint. This can be done for different reason (fraud and security, unpayed subscription, ...). Once suspended, operations related to this enduser won't be allowed, no Outgoing transaction can be done from this Corporate : transaction to a beneficiary will be Declined and Cards will be blocked. Corporate suspension status will be set to SUSPENDED

This does not prevent Incoming transactions. Money can still be received with Incoming transfers for example.

This is a reversible state, and a enuser can be unsuspended with the "Unsuspend a enduser" endpoint.