The identity and technical contract details declared by the specification.
beneficiary_typed_brl_base
object
BRL / PIX shared shape. The PIX key form is the corridor (BRLTAXID / BRLEVPRANDOM / BRLEMAIL / BRLPHONENUMBER). asset (BRL) and accountnumbertype are kept (pin…
4 properties
4 required
request_id
string
Request identifier.
beneficiary_info_legal
Data about Beneficiary of type Legal.
beneficiary_travel_rule_custodial
object
Custodial travel rule information.
sanitized_string
string
Allow alphanumeric, +, -, , &, (, ), °, space, single quote, comma, and all accented characters.
beneficiary_typed_hkd_fps_account_number
object
HKD FPS — bank account number + HK bank (clearing) code, name, address.
4 properties
4 required
beneficiary_info_base
object
Shared CPN requirement fields for natural and legal beneficiaries. Not used directly; merged via allOf.
4 properties
bank_identifier
string
The bank's identification code, which can be either a BIC (Bank Identifier Code) for international transfers or a routing number for domestic transfers. This i…
beneficiary_wallet_details_fiat
Data about Wallet Details of type fiat for beneficiary creation.
beneficiary_batch_item
object
Beneficiary data used in batch endpoints.
2 properties
1 required
ngn_bank_name
string
Allowed Nigerian banks for NGN — CPN's BANKNAME closed list (BANK-TRANSFER). Snapshot of CPN /requirements (2026-05-28); refresh when CPN changes it.
beneficiary_wallet_details_digital
Data about Wallet Details of type digital.
approval_group
object
An approver group whose authorization rule is still awaiting a sign-off.
2 properties
2 required
beneficiary_typed_hkd_account_number
object
HKD WIRE — account number, SWIFT/BIC, bank country, bank, name, address.
4 properties
4 required
address_required_constraint_all_fields
object
Constraint on address component to ensure all fields are set.
4 required
beneficiary_typed_ngn
object
NGN bank transfer — account number, bank, name, address.
4 properties
4 required
wallet_details_common
object
Minimal info in common about Wallet Details.
1 property
1 required
beneficiary_type
string
Type of beneficiary.
pagination
object
Information about the pagination of the request
1 property
1 required
beneficiary_typed_mxn
object
MXN SPEI transfer — CLABE, national id, name, address.
4 properties
4 required
beneficiary_info_choice
Beneficiary identity — individual, company, or self.
beneficiary_info_with_state_province
Identity for corridors that require a state/province in the beneficiary address (e.g. CN). 'self' carries no address in the payload — it is taken from the orig…
beneficiary_raw_data
Beneficiary information without id.
object_id
object
Unique id of object
1 property
meta
object
Metadata of the request
1 property
1 required
beneficiary_typed_hkd_fps_id
object
HKD FPS — FPS identifier, name, address.
4 properties
4 required
cop_bank_name
string
Allowed Colombian banks for COP — CPN's BANKNAME closed list. Snapshot of CPN /requirements (2026-05-28); refresh when CPN changes the list.
php_bank_name
string
Allowed Philippine banks for PHP — union of CPN's InstaPay (86) and PESONet (100) BANKNAME closed lists; the method (and thus list) is server-derived, so the u…
query_parameters
object
Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned
sanitized_string_with_dot
string
Allow alphanumeric, +, -, , &, (, ), °, ., space, single quote, comma, and all accented characters.
json_error_source
object
representation of source in jsonerror format.
1 property
1 required
company_name
string
Allow alphanumeric, +, -, , &, (, ), ., space, single quote, comma, and all accented characters.
beneficiary_typed_cop
object
COP bank transfer — account number, bank, account type, national id.
4 properties
4 required
beneficiary_info_natural_id_required
Individual beneficiary that must carry a national identification number.
beneficiary_info_natural_state_province_required
Individual whose beneficiary address must carry a state/province (e.g. CN).
beneficiary_travel_rule
Travel rule data linked to a beneficiary
beneficiary_typed_attributes
Beneficiary attributes selected by corridor.
beneficiary_typed_brl_evp_random
BRL / PIX — EVP random key.
vop_close_match
string
If the code is "CMTC" (close match), this field contains the string that was returned as the name of the beneficiary by its bank, which differs from the name o…
approval_progress
object
AND multi-rule approval progress for the pending action on an entity, embedded in detail responses. Present only when a pending action exists; a freshly-initia…
3 properties
3 required
asset
string
The symbol/ticker of the crypto asset.
beneficiary_corridor
string
The beneficiary's payout corridor — the discriminator used on typed create. digital for crypto wallets; for fiat, the destination currency (e.g. EUR, USD, COP)…
beneficiary_info_legal_state_province_required
Company whose beneficiary address must carry a state/province (e.g. CN).
beneficiary_wallet_details_digital_tag
Data about Wallet Details of type digital with tag.
account_number
string
The account number of the beneficiary who will receive the funds. This is the unique identifier for the recipient's bank account.
travel_rule_status
string
Travel Rule status
vasp_name
string
Allow alphanumeric, +, -, , &, (, ), °, ., ;, space, single quote, comma, and all accented characters.
beneficiary_info_with_national_id
Identity for corridors that require a national id (e.g. CO, BR, MX). The id is required on tier beneficiaries (individual / company); 'self' carries no nationa…
beneficiary_typed_brl_tax_id
BRL / PIX — CPF/CNPJ tax-id key.
json_error
object
representation of an error in json format.
3 properties
3 required
beneficiary_typed_data
Beneficiary keyed on corridor (crypto or destination currency).
travel_rule_non_custodial
object
Non custodial travel rule information.
1 property
1 required
beneficiary_typed_digital
object
Crypto payout — wallet address, optional tag.
4 properties
4 required
country_code
string
Code 2 characters of country
beneficiary_info_with_national_id_and_phone
COP identity. Like beneficiaryinfowithnationalid, but the individual branch also requires a phone number (CPN RECIPIENTPHONENUMBER is mandatory for COP B2C pay…
wallet_details_beneficiary
Wallet details digital/fiat used for beneficiary.
beneficiary_typed_php
object
PHP transfer (InstaPay or PESONet) — account number, bank, name, address.
4 properties
4 required
sanitized_name
string
A string that must contain only upper and lower case letters, spaces, hyphens, and single quote characters
beneficiary_typed_sgd
object
SGD bank transfer — account number, SWIFT/BIC, bank, name, address.
4 properties
4 required
beneficiary_info_natural_id_phone_required
Individual beneficiary that must carry a national identification number AND a phone number. COP's BANK-TRANSFER B2C corridor requires CPN RECIPIENTPHONENUMBER…
beneficiary_status
string
Beneficiary status
beneficiary_typed_hkd_fps_email
object
HKD FPS — registered email, name, address.
4 properties
4 required
beneficiary_typed_brl_phone_number
BRL / PIX — phone (E.164) key.
beneficiary_info_natural
Data about Beneficiary of type Natural.
beneficiary_description
Free-text label of the beneficiary, shown in listings.
beneficiary_typed_brl_email
BRL / PIX — email key.
beneficiary_info_business_choice
Identity for corridors that only serve business beneficiaries (HK FPS routes are B2B/C2B): a company, or 'self' (the originator company). Individuals are not a…
uuid
string
128-bit value used to uniquely identify an object.
beneficiary_is_self
object
Is self type for the beneficiary.
1 property
1 required
beneficiary_data
Beneficiary information with id
beneficiary_info_legal_id_required
Company beneficiary that must carry a national identification number.
wallet_address
string
The public address associated with a wallet details on the blockchain.
beneficiary_typed_hkd_fps_phone_number
object
HKD FPS — registered phone (E.164), name, address.
4 properties
4 required
vop_code
string
Code identifying the result of the verification, as defined in the VOP specification: - MTCH: "Match" (the beneficiary name being matches what is registered at…
address
object
A physical address.
5 properties
beneficiary_typed_eur
object
EUR / SEPA payout — IBAN + name + address.
4 properties
4 required
data_default
object
Fields required on all objects.
2 properties
2 required
beneficiary_typed_cny
object
CNY transfer (CIPS or WIRE) — account number, SWIFT/BIC, bank country, bank, name, address.
4 properties
4 required
account_identifiers
object
Account + bank identifiers for a fiat beneficiary. This is the legacy create shape (unchanged from before the typed model: only accountnumber + accountnumberty…
7 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Fipto publishes across the network.
