Optionaldelete?: undefinedOptionalget?: undefinedHEAD
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind master account balances by master account ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: { currencyCode?: string }OptionalcurrencyCode?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind master account balance histories by master account ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalcurrencyCode?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedClose account
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind master account by virtual child account ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind virtual child accounts by master account ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedChanges personal information of a person
Update personal information for either a private or a legal person. Including sex (gender), nationality, and residency country code Updates only the specified fields of a person. Fields not included in the request remain unchanged. Null values explicitly set fields to null. Missing fields are ignored.
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedActivate person
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedChanges additional information of a person
Update additional information for either a private or a legal person. Including date of birth, country of birth, pep, registration date, counterparty sector (NAICS) code, and web address. Please refer to the full list of counterparty sectors (NAICS) list here: https://docs.zenus.io/docs/naics-codes Deprecated. Use PATCH /api/v1/persons/{personId} instead. Changes additional information of a person. The person must be in PENDING or ACTIVE status
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedFind person addresses
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedChanges personal information of a person
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate legal person relationships
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedClose person relationship
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate a risk for given person
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedRetrieve custom field values for a person
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate private person occupation
Add the occupation (SOC) code for a private person. Please refer to the full occupations list here: https://docs.zenus.io/docs/occupation-soc-list Deprecated. Use api/zv1/persons/{personId}/custom-fields/value/batch instead
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedUpload files
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedSearch persons
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionaladdressTypeCode?: OptionalbirthDate?: stringOptionalcountry?: stringOptionalcreationDateFrom?: stringOptionalcreationDateTo?: stringOptionalfirstName?: stringOptionalglobalSearch?: stringOptionalidNumber?: stringOptionallastName?: stringOptionalname?: stringOptionalpersonId?: stringOptionalpersonIds?: string[]OptionalpersonTypeCode?: "P" | "L"OptionalregistrationDate?: stringOptionalresidencyCountryCode?: stringOptionalsort?: { field?: string | null; order?: string | null }[]OptionalstatusCode?: "ACTIVE" | "INACTIVE" | "PENDING"OptionalstatusCodeReason?: stringOptionalstatusCodes?: string[]Optionalzip?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind Payment by Payment ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedReturn payment
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate person
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate person address
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedUpdate person address
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedRetrieve person relationship
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: { includeAccessRestricted?: boolean }OptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedUpdate person relationship
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedInsert custom field for a person
Add additional information for a person such as:
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Update custom field for a person
Add additional information for a person such as:
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedSearch Persons
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind Payment by Account ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalamountFrom?: numberOptionalamountTo?: numberOptionalcancellationRequestStatusCodes?: string[]OptionalcontractNumber?: stringOptionalcounterpartyAccountNumber?: stringOptionalcurrencyCodes?: string[]Optionaldetails?: stringOptionaldirectionCode?: stringOptionalisNotSettled?: booleanOptionalisSettled?: booleanOptionalpaymentId?: stringOptionalpaymentServiceProviderCode?: stringOptionalpaymentTypeCodes?: string[]OptionalpostingDateFrom?: stringOptionalpostingDateTo?: stringOptionalreferenceNumber?: stringOptionalsourceName?: stringOptionalsourceRef?: stringOptionalstatusCodes?: string[]OptionalvalueDateFrom?: stringOptionalvalueDateTo?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind account by master account number
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCancel payment
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedConfirm payment
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedInitialize ACH/SWIFT payment
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind person by ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind master account transaction
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind account by ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedSearch master account transactions
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalamountFrom?: numberOptionalamountTo?: numberOptionalcontractNumber?: stringOptionalcurrencyCode?: stringOptionaldirectionCode?: stringOptionalincludeAccessRestricted?: booleanOptionalpageNumber?: numberOptionalpageSize?: numberOptionalreferenceNumber?: stringOptionalsourceName?: stringOptionalsourceRef?: stringOptionaltransactionGroupCode?: stringOptionaltransactionSubtype?: stringOptionaltransactionType?: stringOptionaluniqueIdentifier?: stringOptionalvirtualAccountId?: stringOptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate a new virtual child account
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedFind person accounts by person ID
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalaccountClassCodes?: string[]OptionalaccountTypeCodes?: ("CURRENCY" | "INTERNAL" | "SAVING" | "SHADOW" | "VIRTUAL")[]OptionalincludeAccessRestricted?: booleanOptionalincludeClosedAccounts?: booleanOptionalstatusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[]OptionalrequestBody?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreates an USDC wallet address in the specified chain
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedAssigns a VRN to the specified account.
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreates an USDC recipient
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedUpload payment files
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedInsert or update custom field value
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedBatch insert or update custom field values
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedUpload KYC files
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedOptionalpost?: undefinedUpdate person identification number
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate new tax number
Optionalcookie?: undefinedOptionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }Optionalx-request-id?: stringOptionalx-tenant-id?: stringOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate legal person
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedCreate private person
Optionalcookie?: undefinedOptionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefinedOptionaldelete?: undefinedOptionalget?: undefinedOptionalhead?: undefinedOptionaloptions?: undefinedOptionalpatch?: undefinedGet new access token
Optionalcookie?: undefinedOptionalheader?: { "x-tenant-id"?: string }Optionalx-tenant-id?: stringOptionalpath?: undefinedOptionalquery?: undefinedOptionalrequestBody?: {Optionalput?: undefinedOptionaltrace?: undefined
This file was auto-generated by openapi-typescript. Do not make direct changes to the file.