# Parties

Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.

__Authentication__

Set your headers

```
Authorization: {your_credentials}
WP-Api-Version: 2025-01-01
```

Replace `{your_credentials}` with your base64-encoded Basic Auth username and password.

__DNS whitelisting__

Whitelist the following URLs:
* `https://try.access.worldpay-bsh.securedataplatform.com/`
* `https://access.worldpay-bsh.securedataplatform.com/`

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

__API collection__

A full set of API examples based on different scenarios.

- <a href="/collections/parties/20250101/OpenApiDocExamples.postman_collection.json" download="wp-parties-api-postman">Download Postman collection </a>
- <a href="/collections/parties/20250101/Try environment.postman_environment.json" download="wp-parties-api-postman-try-env">Download environment config for try env </a>


Version: 2025-01-01
Metadata:
  - catalog-list: true
  - business: ["Marketplaces"]
  - category: ["Parties"]
  - generated: true

## Servers

Test (Try)
```
https://try.access.worldpay-bsh.securedataplatform.com
```

Live
```
https://access.worldpay-bsh.securedataplatform.com
```

## Security

### basicAuth

Basic authentication with user name and password

Type: http
Scheme: basic

## Download OpenAPI description

[Parties](https://worldpay-portal.eu.redocly.app/access/_bundle/products/parties/@20250101/openapi.yaml)

## Parties

Create and maintain parties.

### Create a party

 - [POST /parties](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/createaccount.md)

### Browse parties

 - [GET /parties](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/browseparties.md): Browse parties and optionally filtered by criteria. Results are paginated.

### View a party

 - [GET /parties/{partyId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/partyquery.md): Retrieve information about a party.

### Update a party

 - [PUT /parties/{partyId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/updateparty.md)

### Deactivate a party

 - [POST /parties/{partyId}/deactivation](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/deactivateparty.md)

### Reactivate a party

 - [POST /parties/{partyId}/activation](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/parties/reactivateparty.md)

## Payout instruments

Create and maintain payout instruments.

### Create a payout instrument

 - [POST /parties/{partyId}/payoutInstruments](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/payout-instruments/createpayoutinstruments.md)

### View a payout instrument

 - [GET /parties/{partyId}/payoutInstruments/{payoutInstrumentId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/payout-instruments/getpayoutinstrument.md)

### Update a payout instrument

 - [PUT /parties/{partyId}/payoutInstruments/{payoutInstrumentId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/payout-instruments/updatepayoutinstruments.md)

## Balance accounts

Create and maintain balance accounts.

### Create a balance account

 - [POST /parties/{partyId}/balanceAccounts](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/balance-accounts/createbalanceaccount.md)

### View a balance account

 - [GET /parties/{partyId}/balanceAccounts/{balanceAccountId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/balance-accounts/getbalanceaccount.md)

### Update a balance account

 - [PUT /parties/{partyId}/balanceAccounts/{balanceAccountId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/balance-accounts/updatebalanceaccount.md)

## Beneficial owners

Create and maintain beneficial owners.

### Create a beneficial owner

 - [POST /parties/{partyId}/beneficialOwners](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/beneficial-owners/createbeneficialowner.md)

### View a beneficial owner

 - [GET /parties/{partyId}/beneficialOwners/{beneficialOwnerId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/beneficial-owners/getbeneficialowner.md)

### Update a beneficial owner

 - [PUT /parties/{partyId}/beneficialOwners/{beneficialOwnerId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/beneficial-owners/updatebeneficialowner.md)

### Delete a beneficial owner

 - [DELETE /parties/{partyId}/beneficialOwners/{beneficialOwnerId}](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/beneficial-owners/deletebeneficialowner.md)

## Identity verification

Enable identity verification check on a party.

### Perform identity verification

 - [POST /parties/{partyId}/identityVerification](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/identity-verification/performidentityverification.md)

### View identity verification status

 - [GET /parties/{partyId}/identityVerification](https://worldpay-portal.eu.redocly.app/access/products/parties/openapi/identity-verification/getidentityverificationstatus.md)