Skip to main content

Create a consumer

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 under API clients in the account menu. Learn more about authentication and how to obtain your API key here.

POST/consumersOpen API reference 
/consumers
{  "profileId": "10001",  "tag": "customer-123",  "rootUser": {    "name": "string",    "surname": "string",    "email": "[email protected]",    "mobile": {      "countryCode": "+44",      "number": "7700900123"    },    "dateOfBirth": {      "year": 1990,      "month": 1,      "day": 1    },    "occupation": "ACCOUNTING",    "address": {      "addressLine1": "1 High Street",      "addressLine2": "Flat 2",      "city": "London",      "postCode": "W1A 1AA",      "state": "Greater London",      "country": "GB"    },    "placeOfBirth": "string",    "nationality": {},    "tag": {},    "locale": "en-GB",    "brand": "Acme"  },  "ipAddress": "string",  "acceptedTerms": true,  "baseCurrency": "GBP",  "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 userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer must always have one root user.'s id.

Next steps​

With the consumer registered, the root userRoot userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer 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.