Skip to main content

Create a consumer identity

To start the onboarding flow, register a consumer by providing your consumer's personal information. The same call also creates the consumer's root user.

Your API key

You can find your API key in the Weavr Portal. Learn more about authentication and how to obtain your API key here.

POST/consumersTry it 
{
  "profileId": "string",
  "tag": "string",
  "rootUser": {
    "name": "string",
    "surname": "string",
    "email": "[email protected]",
    "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"
  },
  "ipAddress": "string",
  "acceptedTerms": true,
  "baseCurrency": "str",
  "feeGroup": "string",
  "sourceOfFunds": "PERSONAL_SAVINGS",
  "sourceOfFundsOther": "string"
}

The response is the consumer object that contains the information you provided together with the id, which is used to identify this particular consumer in subsequent API calls. The response also includes the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user.'s id.

Next steps​

With the consumer registered, the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. is created but not yet usable. To activate the consumer:

  1. Set up the root user - set their password, verify their email, and enroll an authentication factor.
  2. Complete KYC - submit due diligence information so the consumer can be verified.