# Consumers

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

## Create a consumer

 - [POST /consumers](https://api.weavr.io/products/multi/openapi/consumers/consumercreate.md): 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.

## Get a consumer

 - [GET /consumers](https://api.weavr.io/products/multi/openapi/consumers/consumerget.md): Retrieve the details of the logged-in Consumer.

## Update a consumer

 - [PATCH /consumers](https://api.weavr.io/products/multi/openapi/consumers/consumerupdate.md): Update the details of the logged-in consumer identity.

If the Consumer root user has already completed KYC, the following details cannot be updated:
  - name
  - surname
  - email
  - mobile Country Code
  - mobile Number
  - date of Birth
  - address

## Send an email verification code to the root user

 - [POST /consumers/verification/email/send](https://api.weavr.io/products/multi/openapi/consumers/consumerrootuseremailverificationcodesend.md): The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code.

This code must then be provided in the _consumerRootUserEmailVerify_ operation to verify the root user's email address.

Note that on the Sandbox Environment, the verificationCode is always set to \"123456\".

## Verify email of the root user

 - [POST /consumers/verification/email/verify](https://api.weavr.io/products/multi/openapi/consumers/consumerrootuseremailverify.md): The second step in verifying the root user's email. The randomly generated code sent to the root user via
email, using the _consumerRootUserEmailVerificationCodeSend_ operation, is submitted here to verify the root user's email.

This is needed as part of the verification process for basic due diligence.

Note that on the Sandbox Environment, emails are not sent and the verification code is always set to \"123456\".

## Start KYC for a consumer

 - [POST /consumers/kyc](https://api.weavr.io/products/multi/openapi/consumers/consumerkycstart.md): Consumers need to complete due diligence (KYC) before they can create instruments and fund transaction.

This operation initiates the due diligence process for the logged-in consumer.  

Due Diligence is handled by a KYC provider, you will need to embed the KYC UI Component in your application to show the KYC screens to your users.

To initialise the KYC UI Component, you need a reference that is given to you in the response of this operation.

## Get KYC for a consumer

 - [GET /consumers/kyc](https://api.weavr.io/products/multi/openapi/consumers/consumerkycget.md): Returns the KYC status for the logged-in consumer.

## Charge fee to a consumer

 - [POST /consumers/fees/charge](https://api.weavr.io/products/multi/openapi/consumers/consumerchargefee.md): Charge a fee to the logged-in consumer based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal.

The fees collected will be deposited into your Revenue Account. The balance and transaction history of your revenue account can be viewed in the Multi Portal.