# Buyers

Buyers are identities representing a business

Once on-boarded, Buyers can create payment runs and pay their suppliers in your application.


## Create a buyer

 - [POST /v1/buyers](https://api.weavr.io/products/payment-run/openapi/buyers/buyercreate.md): Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin. 

The information provided must be accurate and will be passed on for KYB verification with our partner.

## Get buyer details

 - [GET /v1/buyers](https://api.weavr.io/products/payment-run/openapi/buyers/buyerget.md): Retrieve the details of the buyer that the logged-in user belongs to.


Required user role: ADMIN

## Update a buyer

 - [PATCH /v1/buyers](https://api.weavr.io/products/payment-run/openapi/buyers/buyerupdate.md): Update the buyer currencies and admin roles.


Required user role: ADMIN

## Start admin user email verification

 - [POST /v1/buyers/verification/email/send](https://api.weavr.io/products/payment-run/openapi/buyers/buyeradminuseremailverificationcodesend.md): The first step in verifying a admin user's email. The admin 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 _buyerAdminUserEmailVerify_ operation to verify the admin user's email address.

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

## Verify admin user email

 - [POST /v1/buyers/verification/email/verify](https://api.weavr.io/products/payment-run/openapi/buyers/buyeradminuseremailverify.md): The second step in verifying the admin user's email. The randomly generated code sent to the admin user via
email, using the _buyerAdminUserEmailVerificationCodeSend_ operation, is submitted here to verify the admin user's email.

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

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

## Start buyer KYB

 - [POST /v1/buyers/kyb](https://api.weavr.io/products/payment-run/openapi/buyers/buyerkybstart.md): Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers.

This operation initiates the due diligence process for the buyer that the logged-in user belongs to.

Due Diligence is handled by a KYB provider - you will need to embed the KYB UI Component in your application so that the buyer will be able to perform the KYB process.

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


Required user role: ADMIN

## Get buyer KYB status

 - [GET /v1/buyers/kyb](https://api.weavr.io/products/payment-run/openapi/buyers/buyerkybget.md): Returns the KYB status for the buyer that the logged-in user belongs to.


Required user role: ADMIN

## Update Buyer's KYB details

 - [PATCH /v1/buyers/kyb](https://api.weavr.io/products/payment-run/openapi/buyers/buyerupdatekyb.md): Update the details of the buyer that the logged-in user belongs to.

The following Buyer details are verified during due diligence (KYB) and cannot be updated via the API once the Buyer has been verified:
- Admin User Name
- Admin User Surname
- Admin User Email
- Admin User Mobile Country Code
- Admin User Mobile Number
- Admin Date of Birth
- Company Business Address

If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process.


Required user role: ADMIN