Update a corporate

Request

Update the details of the logged-in corporate identity.

The following Corporate details are verified during due diligence (KYB) and cannot be updated via the API once the Corporate has been verified:

Root User Name
Root User Surname
Root User Email
Root User Mobile Country Code
Root User Mobile Number
Business Address
Date of birth

If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process.

Security

auth_token and api-key

idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

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.

companyBusinessAddressobject(Address)

feeGroupstring

The fee group which the Corporate 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.

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

The first name of the Corporate root user.

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

The last name of the Corporate root user.

emailstring, (email)(Email)

E-mail Address of the user

mobileobject(Mobile)

dateOfBirthobject(Date)

Date of birth of the authorised user.

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.

industrystring(Industry)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(CorporateSourceOfFunds)deprecated

The corporate's source of funds.

Enum:"LABOUR_CONTRACT""CIVIL_CONTRACT""RENT""FUNDS_FROM_OTHER_AUXILIARY_SOURCES""SALE_OF_MOVABLE_ASSETS""SALE_OF_REAL_ESTATE""ORDINARY_BUSINESS_ACTIVITY""DIVIDENDS""LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS""LOAN_FROM_THIRD_PARTIES"

sourceOfFundsOtherstringdeprecated

Description of source of funds in case OTHER was chosen.

curl -i -X PATCH \
  https://sandbox.weavr.io/multi/corporates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "tag": "string",
    "industry": "ACCOUNTING",
    "sourceOfFunds": "LABOUR_CONTRACT",
    "sourceOfFundsOther": "string",
    "companyBusinessAddress": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "postCode": "string",
      "state": "string",
      "country": "st"
    },
    "feeGroup": "string",
    "baseCurrency": "str",
    "name": "string",
    "surname": "string",
    "email": "user@example.com",
    "mobile": {
      "countryCode": "stri",
      "number": "string"
    },
    "dateOfBirth": {
      "year": 1900,
      "month": 1,
      "day": 1
    },
    "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 Corporate 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(CorporateRootUser)required

The root user of the Corporate Identity.

companyobjectrequired

acceptedTermsboolean

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

ipAddressstring, [ 5 .. 45 ] charactersrequired

The IP address of the user doing the registration.

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

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

feeGroupstring

Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field.

creationTimestampinteger, (int64)required

The time when the Corporate was created, expressed in Epoch timestamp using millisecond precision.

retailQualifierstring

Indicates the type of corporate entity based on its retail status.

Enum:"RETAIL""NON_RETAIL""UNKNOWN"