Are you looking for test card numbers?

Would you like to contact support?

No momento, esta página não está disponível em português
Marketpay icon

Manage account holders

Learn how to manage account holders on your platform.

Here we explain how to manage your account holders and what they can do in your platform.

View account holders

To view account holder details, you can either make an API request or use your Balance Platform Customer Area. The following tabs explain both methods.

To get account holders, use the following endpoints:

View legal entity details

To view the legal entity details of an account holder in your Balance Platform Customer Area, you can search for the account holder associated to the legal entity. As an alternative:

  1. Go to Accounts & balances > Account holders.
  2. In the account holder table, select an Account holder ID.
  3. In the Account holder details page, select Overview > Legal entity.

The Legal entity details of the main legal entity are shown. You can view bank account information for the main legal entity under Transfer instruments.

If the legal entity is an organization, the page also shows details about the associated legal entities under Entity associations.

If the legal entity is an individual or a sole proprietorship, their personally identifiable information (PII) is redacted. Personally identifiable information includes their:

  • Name
  • Address (except for the country)
  • Date of birth
  • Email address
  • Phone number
  • IBAN or bank account number

To view this information in its unredacted state, you must have either the BalancePlatform Merchant Admin or View PII Data on balance platform user role.

View KYC summary and timeline

You can view information about the verification process for account holders in your platform. This includes an overview of the current verification status for associated legal entities and a timeline of KYC-related events. You can use this information to help your users troubleshoot issues they experience during the onboarding process.

  1. Log in to your Balance Platform Customer Area.
  2. Go to Accounts & balances > Account holders.
  3. In the account holder table, select Search to search by account holder ID, reference, legal entity ID or name.
  4. In the search window, select View account holder to open the Account holder details page.
  5. Select KYC timeline.

The KYC summary section shows the current status of the KYC checks separated by the type of check, for example Identity. If there are multiple legal entities linked to the account holder, the type of each legal entity is specified, for example Individual.

To view more detailed information about the order of the KYC checks and events that affected the verification process, look at the KYC timeline. You can filter events by the type of check, legal entity ID, and legal entity name. The timeline also includes any verification errors and the corresponding remediating action codes.

View capabilities

View an account holder's capabilities and their verification status in your Balance Platform Customer Area or by making a GET /accountHolders/{id} request. The following tabs explain both methods.

When you make a GET /accountHolders/{id} request, refer to the following response parameters in the capabilities object:

  • allowed: Boolean that indicates whether the capability is allowed.
  • verificationStatus: The status of the checks. The possible values are invalid, pending, rejected, or valid.
  • problems array: When this array is not empty, this means that there are errors that you need to address. Refer to verification error codes for a list of verification errors.

Request a capability

Some capabilities are automatically requested when you create an account holder. However, your account holders may need additional capabilities if, for example, your business expands its financial product offering. In these cases, you must request the additional capabilities.

The following tabs show how to request a capability.

Default capabilities are automatically requested when you create an account holder. However, if you need to request a specific capability, you must update the account holder and include the capabilities map.

In your PATCH /accountHolders/{id} request, set the capability that you are requesting as the key, and specify the following fields in the object:

Here is an example of how to update an existing account holder to request the receivePayment capability. If you're requesting for multiple capabilities, add another set of key-value object.

You receive a response informing you that the capability has been requested and the verification status is pending.

Enable or disable a capability

To allow or prevent an account holder from using a capability, update the capability in your Balance Platform Customer Area or request a PATCH /accountHolders/{id}. The following tabs explain both methods.

To disable a capability, make a PATCH /accountHolders/{id} request to update the capability. Set the enabled field to false.

Update an account holder

After you create an account holder resource, you might need to update the resource at a later time. For example, an account holder that has several balance accounts might want to change their primary balance account.

To update an account holder, make a PATCH /accountHolders/{id} request.

The example below shows how you can change the primary balance account of an account holder by sending the primaryBalanceAccount field.

Permanently deactivate account holders and their balance accounts

When an account holder discontinues their business, you can permanently deactivate them from your platform.

In some scenarios, you might also want to close a balance account but keep the account holder active. For example, an account holder that has separate balance accounts for their businesses might want to only close one of their businesses.

To close balance accounts and account holders:

  1. Check if they have zero balance in their balance accounts. You can only close empty balance accounts, so if there are funds left, you must pay out or transfer any remaining balance.

  2. Close balance accounts by updating each balance account and setting the status to Closed. Start with those that are not the primary balance account. You can only close a primary balance account if the account holder's other balance accounts are already closed.

  3. Finally, permanently deactivate the account holder by updating the account holder and setting the status to Closed.