Corporates

Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.

Operations

Register a corporate

Request

Create a corporate identity for a business customer. The information provided must be accurate and will be passed on for KYB verification with our partner.

Security

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

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.

rootUserCreateCorporateRootUser (object) or CreateCorporateRootUserId (object)required

One of:

The root user needs to be a director or a legal representative of the corporate that is being onboarded - this user cannot be deactivated.

Root users need to verify their email address and mobile number, as well as complete KYC as part of the Corporate's due diligence process.

companyobjectrequired

The details associated with the company being on-boarded. The details provided need to match exactly with the details provided during KYB.

ipAddressstring, [ 5 .. 45 ] charactersrequired

The IP address of the corporate 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.

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.

acceptedTermsbooleandeprecated

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

curl -i -X POST \
  https://sandbox.weavr.io/multi/corporates \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "profileId": "string",
    "tag": "string",
    "rootUser": {
      "name": "string",
      "surname": "string",
      "email": "user@example.com",
      "mobile": {
        "countryCode": "stri",
        "number": "string"
      },
      "companyPosition": "DIRECTOR",
      "dateOfBirth": {
        "year": 1900,
        "month": 1,
        "day": 1
      },
      "tag": "string",
      "locale": "en-GB",
      "brand": "string"
    },
    "company": {
      "type": "SOLE_TRADER",
      "businessAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "postCode": "string",
        "state": "string",
        "country": "st"
      },
      "name": "string",
      "registrationNumber": "string",
      "registrationCountry": "st"
    },
    "industry": "ACCOUNTING",
    "sourceOfFunds": "LABOUR_CONTRACT",
    "sourceOfFundsOther": "string",
    "acceptedTerms": true,
    "ipAddress": "string",
    "baseCurrency": "str",
    "feeGroup": "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(CreatedCorporateRootUser)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"