Consumers

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

Operations

Register a consumer

Request

Create a Consumer Identity to represent an Individual.

The information provided must be accurate as it will be passed on for KYC verification with our partner.

Incorrect information may incur a re-processing fee.

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.

rootUserobjectrequired

The root user represents the identity.

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

ipAddressstring, [ 5 .. 45 ] charactersrequired

The IP address of the user doing the registration.

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

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

feeGroupstring

The fee group which the consumer is bound to. Fee groups provide the possibility of different fees to users under the same profile. If fee groups are not required, ignore this field.

acceptedTermsbooleandeprecated

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

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 POST \
  https://sandbox.weavr.io/multi/consumers \
  -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"
      },
      "dateOfBirth": {
        "year": 1900,
        "month": 1,
        "day": 1
      },
      "occupation": "ACCOUNTING",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "postCode": "string",
        "state": "string",
        "country": "st"
      },
      "placeOfBirth": "string",
      "nationality": "st",
      "tag": "string",
      "locale": "en-GB",
      "brand": "string"
    },
    "ipAddress": "string",
    "acceptedTerms": true,
    "baseCurrency": "str",
    "feeGroup": "string",
    "sourceOfFunds": "PERSONAL_SAVINGS",
    "sourceOfFundsOther": "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.