Create entity beneficiary

Submit a non-natural-person (business) beneficiary to the zerohash ecosystem, a legal entity that receives payouts through your platform. zerohash runs the required business and returns a participant_code used to reference the beneficiary across all other endpoints.

Available only to platforms leveraging zerohash for beneficiary services. Contact us for more information on enabling it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Entity beneficiary profile data including business information and registration details.

string
required
string
required

Phone number of the business

string
required

First line for the business's address.

Notes:

  • The regular maximum length is 80 characters.
  • If the platform is on the vendor reliance track, the maximum length increases to 200 characters.
  • PO Box addresses are not accepted.
string
required

The city customer resides in

string
required

Postal, or zip code, of the business, in the format "min 4 characters, no leading or trailing spaces" for non-US postal code or <5digits>-<4digits> for US zip code, e.g. 77777 or 77777-7777

string
required

The ISO 3166-2 subdivision code that the customer resides in

string
required

Tax identifier of the business (e.g. EIN in United States)

string
required

ISO-3166-1_A2 country code that issued the tax identifier (e.g. “US”)

string

Extra information, like an apartment or suite number.

Notes:

  • The regular maximum length is 50 characters.
  • If the platform is on the vendor reliance track, the maximum length increases to 200 characters.
  • PO Box addresses are not accepted.
string
string

The identification number of the entity (e.g. LEI, VAT number, chamber of commerce number).

string
enum

The type of identification provided for the entity. Entity-valid types only: ein (US), legal_entity_identifier / chamber_of_commerce_number / value_added_tax_number (EU), or non_us_other (other non-US jurisdictions). non_us_other_type is required when non_us_other.

Allowed:
string

Free-form description of the non-US entity ID type. Required when id_number_type is non_us_other.

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

uuid

Optional client-supplied request ID used for tracing and idempotency. Must be a UUID v4. When omitted, zerohash generates one and returns it in the response X-Request-Id header.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json