Corporates

Get a corporate

Returns the corporate associated with the authentication token, including its company details, contact information, and current state.

Read the corporate overview for the corporate lifecycle and onboarding flow.

get/corporates

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/corporates
  • Auth: HTTP bearer and API key in header api-key

Response

Success

profileIdstring 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

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

industry'ACCOUNTING' | 'AUDIT' | 'FINANCE' | 'PUBLIC_SECTOR_ADMINISTRATION' | 'ART_ENTERTAINMENT' | 'AUTO_AVIATION' | 'BANKING_LENDING' | 'BUSINESS_CONSULTANCY_LEGAL' | 'CONSTRUCTION_REPAIR' | 'EDUCATION_PROFESSIONAL_SERVICES' | 'INFORMATIONAL_TECHNOLOGIES' | 'TOBACCO_ALCOHOL' | 'GAMING_GAMBLING' | 'MEDICAL_SERVICES' | 'MANUFACTURING' | 'PR_MARKETING' | 'PRECIOUS_GOODS_JEWELRY' | 'NON_GOVERNMENTAL_ORGANIZATION' | 'INSURANCE_SECURITY' | 'RETAIL_WHOLESALE' | 'TRAVEL_TOURISM' | 'FREELANCER'

The industry of the identity.

sourceOfFunds'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' | 'SALE_OF_COMPANY_SHARES_BUSINESS' | 'OTHER' | 'DONATION' | 'INHERITANCE' | 'ORIGIN_OF_FUNDS_UNKNOWN'

The corporate's source of funds.

sourceOfFundsOtherstring

Description of source of funds in case OTHER was chosen.

acceptedTermsboolean

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

ipAddressstring required

The IP address of the user doing the registration.

baseCurrencystring 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 required

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

retailQualifier'RETAIL' | 'NON_RETAIL' | 'UNKNOWN'

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

Example response

{
  "id": {
    "type": "CONSUMER",
    "id": "123456789"
  },
  "profileId": "10001",
  "tag": "customer-123",
  "rootUser": {
    "id": {
      "type": "CONSUMER",
      "id": "123456789"
    },
    "name": "Alex",
    "surname": "Smith",
    "email": "alex@example.com",
    "mobile": {
      "countryCode": "+44",
      "number": "7700900123"
    },
    "active": true,
    "emailVerified": true,
    "mobileNumberVerified": true,
    "dateOfBirth": {
      "year": 1990,
      "month": 1,
      "day": 1
    },
    "tag": "customer-123",
    "locale": "en-GB",
    "brand": "Acme"
  },
  "company": {
    "name": "Acme Ltd",
    "registrationNumber": "12345678",
    "registeredAddress": {
      "addressLine1": "1 High Street",
      "addressLine2": "Flat 2",
      "city": "London",
      "postCode": "W1A 1AA",
      "state": "Greater London",
      "country": "GB"
    },
    "businessAddress": {
      "addressLine1": "1 High Street",
      "addressLine2": "Flat 2",
      "city": "London",
      "postCode": "W1A 1AA",
      "state": "Greater London",
      "country": "GB"
    },
    "countryOfRegistration": "GB",
    "incorporatedOn": {
      "year": 1990,
      "month": 1,
      "day": 1
    }
  },
  "sourceOfFundsOther": "Inheritance",
  "acceptedTerms": true,
  "ipAddress": "203.0.113.10",
  "baseCurrency": "GBP",
  "feeGroup": "DEFAULT",
  "creationTimestamp": 1786118400000
}

Changes

No recorded changes to this operation across all 1 revision of this API.