Consumers

Get a consumer

Returns the consumer associated with the authentication token, including their profile, contact details, and current state.

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

get/consumers

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/consumers
  • 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.

creationTimestampinteger required

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

ipAddressstring required

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.

baseCurrencystring

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

feeGroupstring

The fee group which the consumer is bound to.

sourceOfFunds'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' | 'LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS' | 'LOAN_FROM_THIRD_PARTIES' | 'INHERITANCE' | 'SALE_OF_COMPANY_SHARES_BUSINESS' | 'OTHER'

The consumer's source of funds.

sourceOfFundsOtherstring

Description of source of funds in case OTHER was chosen.

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
    },
    "address": {
      "addressLine1": "1 High Street",
      "addressLine2": "Flat 2",
      "city": "London",
      "postCode": "W1A 1AA",
      "state": "Greater London",
      "country": "GB"
    },
    "nationality": "GB",
    "placeOfBirth": "London",
    "tag": "customer-123",
    "locale": "en-GB",
    "brand": "Acme"
  },
  "creationTimestamp": 1786118400000,
  "ipAddress": "203.0.113.10",
  "acceptedTerms": true,
  "baseCurrency": "GBP",
  "feeGroup": "DEFAULT",
  "sourceOfFundsOther": "Inheritance"
}

Changes

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