Update a consumer

Request

Update the details of the logged-in consumer identity.

If the Consumer root user has already completed KYC, the following details cannot be updated:

name
surname
email
mobile Country Code
mobile Number
date of Birth
address

Security

auth_token and api-key

Bodyapplication/jsonrequired

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

namestring, <= 20 characters^[^0-9~!@#$%^*()_+={}\|:;,<>/?]*$

The first name of the Consumer root user.

surnamestring, <= 20 characters^[^0-9~!@#$%^*()_+={}\|:;,<>/?]*$

The last name of the Consumer root user.

emailstring, (email)(Email)

E-mail Address of the user

mobileobject(Mobile)

dateOfBirthobject(Date)

Date of birth of the consumer root user.

addressobject(AddressWithCountryRequired)

Address of the consumer root user.

feeGroupstring

The fee group which the consumer will be bound to. Do not specify this if you are not using fee groups.

baseCurrencystring, = 3 characters(Currency)^[A-Z]*$

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

placeOfBirthstring

The place of birth of the consumer root user.

nationalitystring, = 2 characters(Nationality)^[A-Z]+$

Nationality of the consumer root user, in ISO 3166 alpha-2 format.

resetMobileCounterboolean

userTagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag to be assigned to the root user.

localestring, <= 5 characters(UserLocale)^[a-z]{2}(-[A-Z]{2})?$

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

Example:"en-GB"

brandstring, <= 25 characters(Brand)^[a-zA-Z0-9]+$

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

occupationstring(Occupation)deprecated

The industry of the identity.

Enum:"ACCOUNTING""AUDIT""FINANCE""PUBLIC_SECTOR_ADMINISTRATION""ART_ENTERTAINMENT""AUTO_AVIATION""BANKING_LENDING""BUSINESS_CONSULTANCY_LEGAL""CONSTRUCTION_REPAIR""EDUCATION_PROFESSIONAL_SERVICES"

sourceOfFundsstring(ConsumerSourceOfFunds)deprecated

The consumer's source of funds.

Enum:"PERSONAL_SAVINGS""FAMILY_SAVINGS""LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS"

sourceOfFundsOtherstringdeprecated

Description of source of funds in case OTHER was chosen.

curl -i -X PATCH \
  https://sandbox.weavr.io/multi/consumers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "tag": "string",
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": {
      "countryCode": "stri",
      "number": "string"
    },
    "dateOfBirth": {
      "year": 1900,
      "month": 1,
      "day": 1
    },
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "postCode": "string",
      "state": "string",
      "country": "st"
    },
    "feeGroup": "string",
    "baseCurrency": "str",
    "occupation": "ACCOUNTING",
    "sourceOfFunds": "PERSONAL_SAVINGS",
    "sourceOfFundsOther": "string",
    "placeOfBirth": "string",
    "nationality": "st",
    "resetMobileCounter": true,
    "userTag": "string",
    "locale": "en-GB",
    "brand": "string"
  }'

Responses

Success

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json

idobject(IdentityId)required

The unique identifier of the Consumer Identity.

profileIdstring(ProfileId)^[0-9]+$required

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

rootUserobject(ConsumerRootUser)required

The root user of the Consumer Identity.

creationTimestampinteger, (int64)required

The time when this consumer was created, expressed in Epoch timestamp using millisecond precision.

ipAddressstring, [ 5 .. 45 ] charactersrequired

The IP address of the consumer user doing the registration.

acceptedTermsboolean

Must be set to true to indicate that the consumer root user has accepted the terms and conditions.