---
title: "Update KYC information"
method: POST
path: "/v2/users/{userId}/kyc"
tags: ["Kyc"]
---

# Update KYC information

`POST /v2/users/{userId}/kyc`

Update the user's KYC information.

The Update KYC endpoint allows you to add or modify the user's existing KYC data. This is the only endpoint available for making changes to the user's KYC information.

HIFI does not provide services to users or businesses from sanctioned and high-risk regions or unsupported US states. See [here](https://docs.hifibridge.com/docs/compliance/regions) for supported regions.

## Path parameters

- `userId` string, required

## Request body

- union
  - IndividualKycUpdate
    - `firstName` string
    - `firstNameLocal` string — first name in local language.
    - `middleName` string
    - `middleNameLocal` string — middle name in local language.
    - `lastName` string
    - `lastNameLocal` string — last name in local language.
    - `nationality` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
    - `email` string, email — E-mail address for compliance-related communications.
    - `phone` string — Phone number in E.164 format "+12223334444".
    - `address` Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `city` string, required
      - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
      - `postalCode` string, required — Must be supplied for countries that use postal codes.
      - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
    - `dateOfBirth` string, date — Date of birth in format yyyy-mm-dd.
    - `countryOfBirth` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
    - `stateOfBirth` string — The state, region, district, county or another territorial entity of birth inside a country, if applicable.
    - `placeOfBirth` string — User place of birth. This can be a city, a town or another settlement type.
    - `gender` 'M' | 'F'
    - `country` string — User country. This is usually a country of the last uploaded ID document, and it may differ from the country of birth. Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
    - `taxIdentificationNumber` string — Taxpayer identification number that is unique to each taxpayer. For individual US customers, SSN should be used. For business US customers, EIN should be used.
    - `taxResidenceCountry` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
    - `ipAddress` string, ipv4 — IP address of the user. (See [here](https://docs.hifibridge.com/docs/compliance/regions) for the list of unsupported countries/states.)
    - `govIdType` 'PASSPORT' | 'ID_CARD' | 'DRIVERS'
    - `govIdFrontUrl` string — URL or Base64 encoded string of the front of the user's government issued ID. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `govIdBackUrl` string — URL or Base64 encoded string of the back of the user's government issued ID. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `govIdCountry` string — Alpha-3 country code of the provided government id as defined in the ISO 3166-1 spec. Note that the government ID may be different from the 'country' above.
    - `govIdNumber` string
    - `govIdIssuanceDate` string, date — The issue date of the Gov ID document in format yyyy-mm-dd.
    - `govIdExpirationDate` string, date — The expiry date of the Gov ID document in format yyyy-mm-dd.
    - `govIdIssuanceAuthority` string — Issuing authority of the Gov ID document.
    - `govIdHandHoldUrl` string — URL or Base64 encoded string of image of the user holding their government issued ID next to their face. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `proofOfAddressType` 'UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT'
    - `proofOfAddressUrl` string — URL or Base64 encoded string of the file of the proof of address. (See [here](https://docs.hifibridge.com/docs/compliance/regions) for the list of unsupported countries/states.) *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `sofEuQuestionnaire` SofEuKycQuestionnaire
      - `actingAsIntermediary` boolean — Is the customer acting as an intermediary for a third party?
      - `employmentStatus` 'employed' | 'homemaker' | 'retired' | 'self_employed' | 'student' | 'unemployed' — What is the customer's current employment status?
      - `expectedMonthlyPayments` '0_4999' | '5000_9999' | '10000_49999' | '50000_plus' — What is the expected monthly volume of payments the customer will be sending or receiving?
      - `mostRecentOccupation` string — What is the customer's most recent occupation? Specify the relevant alphanumeric occupation code. See the [list](https://docs.hifibridge.com/docs/compliance/references/occupations) of occupations for the complete list of valid occupations and codes.
      - `primaryPurpose` 'charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'operating_a_company' | 'payments_to_friends_or_family_abroad' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payment_for_freelancing' | 'receive_salary' | 'other' — What is the primary purpose of the customer's account?
      - `primaryPurposeOther` string — Required if the primary purpose is 'other'.
      - `sourceOfFunds` 'company_funds' | 'ecommerce_reseller' | 'gambling_proceeds' | 'gifts' | 'government_benefits' | 'inheritance' | 'investments_loans' | 'pension_retirement' | 'salary' | 'sale_of_assets_real_estate' | 'savings' | 'someone_elses_funds' — What is the source of funds for the customer's account?
    - `idType` 'PASSPORT' | 'ID_CARD' | 'DRIVERS' | 'NIN'
    - `idNumber` string
    - `additionalIdType` string — Required only for "AFRICA_NIGERIA" rail and must be "BVN" type:
    - `additionalIdNumber` string — Required only for "AFRICA_NIGERIA" rail and must be the BVN number.
    - `purpose` unknown[] — The purposes for unlocking this rail. Multiple values can be put into an array. Only required for `MULTI_CURRENCY_ACCOUNT` rail. Look up the purpose code [here](https://docs.hifibridge.com/docs/compliance/references/account-purposes).
      - unknown
    - `productServiceCategory` string — The category of the product or service the user is in. Only required for `MULTI_CURRENCY_ACCOUNT` rail. Look up the product and service category code [here](https://docs.hifibridge.com/docs/compliance/references/product-service-categories).
    - `supplementaryInfo` string — This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
    - `supplementaryUrl` string — This field is designed to contain supplementary documents or files that can be uploaded as part of the KYC process. URL or Base64 encoded string of the file of the supplementary information. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
  - BusinessKycUpdate
    - `businessName` string — The full legal name of the business.
    - `businessNameLocal` string — The full legal name of the business in the local language.
    - `alternativeNames` string[] — Alternative names of the business.
    - `businessDescription` string
    - `businessIndustry` string — The industry in which this business operates. Click [here](https://docs.hifibridge.com/docs/compliance/references/business-industries) for the complete list of valid industries and codes.
    - `businessType` 'cooperative' | 's_corporation' | 'b_corporation' | 'c_corporation' | 'close_corporation' | 'nonprofit_corporation' | 'general_partnership' | 'limited_partnership' | 'limited_liability_company' | 'other' | 'sole_proprietorship' | 'trust' — The type of business structure that most closely matches the business customer.
    - `email` string, email — Email address for compliance-related communications.
    - `phone` string — Phone number in E.164 format "+12223334444".
    - `taxIdentificationNumberType` 'EIN' | 'SSN' | 'VAT' | 'TIN' | 'UTR' — Company tax id type
    - `taxIdentificationNumber` string — Company tax number. US businesses should provide EIN.
    - `registrationNumber` string — Business Registration Number.
    - `leiNumber` string — Legal Entity Identifier (LEI) is a 20-character alphanumeric code that uniquely identifies a legal entity participating in financial transactions. LEI is required for businesses based in the European Economic Area (EEA) and Switzerland.
    - `formationDate` string, date — Company formation date.
    - `incorporationDate` string, date — Date of incorporation in format yyyy-mm-dd.
    - `incorporationCountry` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
    - `incorporationState` string
    - `website` string
    - `address` Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `city` string, required
      - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
      - `postalCode` string, required — Must be supplied for countries that use postal codes.
      - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
    - `registeredAddress` Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `city` string, required
      - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
      - `postalCode` string, required — Must be supplied for countries that use postal codes.
      - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
    - `postalAddress` Address
      - `addressLine1` string, required
      - `addressLine2` string
      - `city` string, required
      - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
      - `postalCode` string, required — Must be supplied for countries that use postal codes.
      - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
    - `ipAddress` string, ipv4 — IP address of the user. (See [here](https://docs.hifibridge.com/docs/compliance/regions) for the list of unsupported countries/states.)
    - `sourceOfFunds` string — The source of funds for the business, e.g. profits, income, venture capital, etc.
    - `transmitsCustomerFunds` boolean — True if the business transmits funds on behalf of its customers.
    - `complianceScreeningExplanation` string — Required if transmitsCustomerFunds is true. An explanation of types of compliance screening (KYC, KYB, or AML) the customer performs before transmitting funds on behalf of its customers.
    - `daoStatus` boolean — Whether the business is a DAO (Decentralized Autonomous Organization)
    - `proofOfAddressType` 'UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT'
    - `proofOfAddressUrl` string — URL or Base64 encoded string of the proof of address that ties the owner's name to the provided address. Typically a utility bill or bank statement. Required for businesses registered or operating in the EEA (European Economic Area). Utility bills and bank statements are recommended for proof of address. (See [here](https://docs.hifibridge.com/docs/compliance/regions) for the list of unsupported countries/states.) *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `formationDocUrl` string — URL or Base64 encoded string of the formation documentation. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `proofOfOwnershipUrl` string — URL or Base64 encoded string of the ownership documentation. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `certificateOfRegistrationDocType` 'ACRA' | 'GST' | 'MSME' | 'CERTIFICATE_OF_REGISTRATION' — Type of the certificate of registration doc.
    - `certificateOfRegistrationDocUrl` string — URL or Base64 encoded string of the certificate of registration. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `certificateNumber` string — A unique number that identifies the business. This is usually the number shown on the certificate of registration.
    - `businessRegistrationDocUrl` string — URL or Base64 encoded string of the business registration document. For business based in HKG only. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `licenseExpirationDate` string, date — Expiry date of company license in format yyyy-mm-dd.
    - `certificateOfIncorporationDocUrl` string — URL or Base64 encoded string of the certificate of incorporation. For business based in HKG only. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `incorporationNumber` string — Certificate of Incorporation Number.
    - `controlScheme` string
    - `shareStructureUrl` string — URL or Base64 encoded string of of the shareholder structure file. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `constitutionOrAnnualReportUrl` string — URL or Base64 encoded string of the company constitution or annual report *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `articlesOfAssociationUrl` string — URL or Base64 encoded string of the articles of association. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `uboDeclarationUrl` string — URL or Base64 encoded string of the UBO (Ultimate Beneficial Owner) declaration. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `partnershipMinsOfMeetingUrl` string — URL or Base64 encoded string of the Partnership Meeting Minutes. For PARTNERSHIP business only. *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `partnershipDeedUrl` string — URL of the Partnership Agreement. For PARTNERSHIP business only. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `certificateOfIncumbencyUrl` string — URL or Base64 encoded string of the Certificate of Incumbency. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `organizationStructureUrl` string — URL or Base64 encoded string of the Organization Structure. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `sourceOfFundsUrl` string — URL or Base64 encoded string of the source of fund document. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `flowOfFundsUrl` string — URL or Base64 encoded string of the flow of funds document. *Maximum file size 3MB and minimum file size 10KB *If the file is base64 encoded, it must start with "data:" *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `purpose` string[] — The purposes for unlocking this rail. Multiple values can be put into an array. Only required for `MULTI_CURRENCY_ACCOUNT` rail. Look up the purpose code [here](https://docs.hifibridge.com/docs/compliance/references/account-purposes).
    - `productServiceCategory` string — The category of the product or service the user is in. Look up the product and service category code [here](https://docs.hifibridge.com/docs/compliance/references/product-service-categories).
    - `tradeName` string — Enterprise trading name. This information is only required if the customer’s business `purpose` includes `OFFLINE`.
    - `exportCountry` string — Export country. This information is only required if the customer’s business `purpose` includes `OFFLINE`.
    - `tradeType` string — Trade type. This information is only required if the customer’s business `purpose` includes `OFFLINE`. Look up export item category codes [here](https://docs.hifibridge.com/docs/compliance/references/export-categories).
    - `supplementaryInfo` string — This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
    - `supplementaryUrl` string — This field is designed to contain supplementary documents or files that can be uploaded as part of the KYC process. URL or Base64 encoded string of the file of the supplementary information. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
    - `sofEuQuestionnaire` SofEuKybQuestionnaire
      - `estimatedAnnualRevenueUsd` '0_99999' | '100000_999999' | '1000000_9999999' | '10000000_49999999' | '50000000_249999999' | '250000000_plus' — Estimated annual revenue in USD.
      - `expectedMonthlyPaymentsUsd` string — Expected monthly payments in USD.
      - `operatesInProhibitedCountries` boolean
      - `primaryPurpose` 'charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'other' | 'payments_to_friends_or_family_abroad' | 'payroll' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payments_for_goods_and_services' | 'tax_optimization' | 'third_party_money_transmission' | 'treasury_management' — What is the primary purpose of the business account?
      - `primaryPurposeOther` string — Required if the primary purpose is 'other'.
      - `highRiskActivities` string[] — List of high-risk activities the business is involved in.
      - `sourceOfFunds` 'business_loans' | 'grants' | 'inter_company_funds' | 'investment_proceeds' | 'legal_settlement' | 'owners_capital' | 'pension_retirement' | 'sale_of_assets' | 'sales_of_goods_and_services' | 'tax_refund' | 'third_party_funds' | 'treasury_reserves' — What is the source of funds for the business account?
      - `sourceOfFundsDescription` string — Description of the source of funds for the business' account.
      - `transmitsCustomerFunds` boolean — Specifies whether the business directly receives, holds, or sends customer funds to another party on behalf of its users. A value of true means the business is acting as a money transmitter and is subject to money transmission regulations in addition to general money service obligations.
      - `transmitsCustomerFundsDescription` string — Describes whether and how the business actively transmits customer funds. i.e., moves money from one party to another on behalf of a customer (e.g., sending, remitting, or transferring funds). This field should clarify the money-transmission activity performed.
      - `customerFundsDescription` string — Describes the nature of the customer funds handled by the business. This field explains the characteristics of the funds rather than the act of transmitting them.
      - `conductsMoneyServices` boolean — Indicates whether the business is engaged in providing money services as a line of business (e.g., money transmission, currency exchange, or other regulated financial activities). A value of true means the business is considered a Money Services Business (MSB) under applicable regulations and may be subject to AML, KYC, and licensing requirements.
    - `ultimateBeneficialOwners` UltimateBeneficialOwner[] — List of ultimate beneficial owners (UBOs) of the business. This list will replace any existing UBOs. Note: This field is deprecated and will be removed in the future. To add or update a specific UBO, please use the UBO-specific endpoints instead.
      - `role` 'OWNER_OR_OPERATOR' | 'PARTNER' | 'UBO' | 'DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP' | 'AGENT_OR_AUTHORISED_PERSON' — The role of the ubo in the business.
      - `roles` string[] — The roles of the ubo in the business.
      - `businessTitle` string — Agent or authorised person‘s job title.
      - `firstName` string — first name in local language.
      - `firstNameLocal` string
      - `middleName` string
      - `middleNameLocal` string — middle name in local language.
      - `lastName` string
      - `lastNameLocal` string — last name in local language.
      - `nationality` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
      - `email` string, email
      - `phone` string
      - `address` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `dateOfBirth` string, date — Date of birth in format yyyy-mm-dd.
      - `countryOfBirth` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
      - `stateOfBirth` string
      - `placeOfBirth` string
      - `gender` 'M' | 'F'
      - `taxIdentificationNumber` string — For US owners, SSN should be used. For non-US individual owners, a national ID is preferred where applicable; however, a tax ID can also be used as an alternative.
      - `taxResidenceCountry` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
      - `govIdType` 'PASSPORT' | 'ID_CARD' | 'DRIVERS'
      - `govIdCountry` string — Three-letter alpha-3 country code of the submitted government id as defined in the ISO 3166-1 spec.
      - `govIdNumber` string
      - `govIdFrontUrl` string — URL or Base64 encoded string of the front of the user's government issued ID. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
      - `govIdBackUrl` string — URL or Base64 encoded string of the back of the user's government issued ID. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
      - `govIdIssuanceDate` string, date — The issue date of the Gov ID document in format yyyy-mm-dd.
      - `govIdExpirationDate` string, date — The expiry date of the Gov ID document in format yyyy-mm-dd.
      - `govIdIssuanceAuthority` string — Issuing authority of the Gov ID document.
      - `proofOfAddressType` 'UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT'
      - `proofOfAddressUrl` string — URL or Base64 encoded string of the file of the proof of address. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
      - `authLetterUrl` string — URL or Base64 encoded string of the authorization letter that the authorised person can act on behalf of the business. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
      - `shareProportion` number — Percentage of shares owned (greater than or equal to 25%), only for UBOs.
      - `hasOwnership` boolean — True if the person has at least 25% ownership of the business.
      - `hasControl` boolean — True if the person has a significant responsibility to control, manage, or direct the activities of the business. At least one of the ultimateBeneficialOwners needs to have this set to true.
      - `isSigner` boolean — True if the person can authorize transactions on behalf of the business. At least one of the ultimateBeneficialOwners needs to have this set to true.
      - `relationshipEstablishedAt` string, date — The date that the ultimateBeneficialOwners first became an owner, control person, or signer for the business in format yyyy-mm-dd.
      - `supplementaryInfo` string — This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
      - `supplementaryUrl` string — This field is designed to contain supplementary documents or files that can be uploaded as part of the KYC process. URL or Base64 encoded string of the file of the supplementary information. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif

## Response `200`

Success

- union
  - KycIndividualObject
    - `userId` string, uuid
    - `kycInfo` object
      - `type` 'individual'
      - `firstName` string
      - `firstNameLocal` string
      - `middleName` string
      - `middleNameLocal` string
      - `lastName` string
      - `lastNameLocal` string
      - `nationality` string
      - `email` string, email
      - `phone` string
      - `address` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `dateOfBirth` string
      - `countryOfBirth` string
      - `stateOfBirth` string
      - `placeOfBirth` string
      - `gender` string
      - `country` string
      - `taxIdentificationNumber` string
      - `taxResidenceCountry` string
      - `govIdType` string
      - `govIdFrontUrl` string
      - `govIdBackUrl` string
      - `govIdCountry` string
      - `govIdNumber` string
      - `govIdIssuanceDate` string
      - `govIdExpirationDate` string
      - `govIdIssuanceAuthority` string
      - `govIdHandHoldUrl` string
      - `proofOfAddressType` string
      - `proofOfAddressUrl` string
      - `sofEuQuestionnaire` SofEuKycQuestionnaire
        - `actingAsIntermediary` boolean — Is the customer acting as an intermediary for a third party?
        - `employmentStatus` 'employed' | 'homemaker' | 'retired' | 'self_employed' | 'student' | 'unemployed' — What is the customer's current employment status?
        - `expectedMonthlyPayments` '0_4999' | '5000_9999' | '10000_49999' | '50000_plus' — What is the expected monthly volume of payments the customer will be sending or receiving?
        - `mostRecentOccupation` string — What is the customer's most recent occupation? Specify the relevant alphanumeric occupation code. See the [list](https://docs.hifibridge.com/docs/compliance/references/occupations) of occupations for the complete list of valid occupations and codes.
        - `primaryPurpose` 'charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'operating_a_company' | 'payments_to_friends_or_family_abroad' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payment_for_freelancing' | 'receive_salary' | 'other' — What is the primary purpose of the customer's account?
        - `primaryPurposeOther` string — Required if the primary purpose is 'other'.
        - `sourceOfFunds` 'company_funds' | 'ecommerce_reseller' | 'gambling_proceeds' | 'gifts' | 'government_benefits' | 'inheritance' | 'investments_loans' | 'pension_retirement' | 'salary' | 'sale_of_assets_real_estate' | 'savings' | 'someone_elses_funds' — What is the source of funds for the customer's account?
      - `ipAddress` string
      - `idType` string
      - `idNumber` string
      - `additionalIdType` string
      - `additionalIdNumber` string
      - `purpose` string
      - `productServiceCategory` string
      - `supplementaryInfo` string
      - `supplementaryUrl` string
      - `documents` DocumentObject[]
        - `type` string
        - `subType` string
        - `issuedCountry` string
        - `issuedDate` string, date
        - `expiryDate` string, date
        - `number` string
        - `description` string
        - `url` string
        - `fileId` string
        - `uboId` string
  - KycBusinessObject
    - `userId` string, uuid
    - `kycInfo` object
      - `type` 'business'
      - `businessName` string
      - `businessNameLocal` string
      - `alternativeNames` string[]
      - `businessDescription` string
      - `email` string, email
      - `phone` string
      - `sourceOfFunds` string
      - `businessType` string
      - `businessIndustry` string
      - `website` string
      - `address` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `registeredAddress` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `postalAddress` Address
        - `addressLine1` string, required
        - `addressLine2` string
        - `city` string, required
        - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
        - `postalCode` string, required — Must be supplied for countries that use postal codes.
        - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
      - `taxIdentificationNumberType` string
      - `taxIdentificationNumber` string
      - `leiNumber` string
      - `daoStatus` boolean
      - `transmitsCustomerFunds` boolean
      - `formationDate` string
      - `ipAddress` string, ipv4
      - `formationDocUrl` string
      - `proofOfOwnershipUrl` string
      - `complianceScreeningExplanation` string
      - `ultimateBeneficialOwners` UboObject[]
        - `role` 'OWNER_OR_OPERATOR' | 'PARTNER' | 'UBO' | 'DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP' | 'AGENT_OR_AUTHORISED_PERSON' — The role of the ubo in the business.
        - `roles` string[] — The roles of the ubo in the business.
        - `businessTitle` string — Agent or authorised person‘s job title.
        - `firstName` string — first name in local language.
        - `firstNameLocal` string
        - `middleName` string
        - `middleNameLocal` string — middle name in local language.
        - `lastName` string
        - `lastNameLocal` string — last name in local language.
        - `nationality` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
        - `email` string, email
        - `phone` string
        - `address` Address
          - `addressLine1` string, required
          - `addressLine2` string
          - `city` string, required
          - `stateProvinceRegion` string, required — The second part of the [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2). This must be provided if the country has subdivisions. An ISO 3166-2 code consists of two parts, separated by a hyphen (`-`): 1. The first part is the ISO 3166-1 alpha-2 code of the country (e.g., `US`, `CA`, `BR`); 2. The second part is a string of up to three alphanumeric characters representing a specific subdivision (e.g., state, province). This is typically based on national standards or developed by ISO. Only provide the second part of the code (e.g., `CA` for California in `US-CA`, or `SP` for São Paulo in `BR-SP`).
          - `postalCode` string, required — Must be supplied for countries that use postal codes.
          - `country` string, required — Three-letter alpha-3 country code as defined in the [ISO 3166-1 spec](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
        - `dateOfBirth` string, date — Date of birth in format yyyy-mm-dd.
        - `countryOfBirth` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
        - `stateOfBirth` string
        - `placeOfBirth` string
        - `gender` 'M' | 'F'
        - `taxIdentificationNumber` string — For US owners, SSN should be used. For non-US individual owners, a national ID is preferred where applicable; however, a tax ID can also be used as an alternative.
        - `taxResidenceCountry` string — Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
        - `govIdType` 'PASSPORT' | 'ID_CARD' | 'DRIVERS'
        - `govIdCountry` string — Three-letter alpha-3 country code of the submitted government id as defined in the ISO 3166-1 spec.
        - `govIdNumber` string
        - `govIdFrontUrl` string — URL or Base64 encoded string of the front of the user's government issued ID. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
        - `govIdBackUrl` string — URL or Base64 encoded string of the back of the user's government issued ID. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
        - `govIdIssuanceDate` string, date — The issue date of the Gov ID document in format yyyy-mm-dd.
        - `govIdExpirationDate` string, date — The expiry date of the Gov ID document in format yyyy-mm-dd.
        - `govIdIssuanceAuthority` string — Issuing authority of the Gov ID document.
        - `proofOfAddressType` 'UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT'
        - `proofOfAddressUrl` string — URL or Base64 encoded string of the file of the proof of address. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
        - `authLetterUrl` string — URL or Base64 encoded string of the authorization letter that the authorised person can act on behalf of the business. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
        - `shareProportion` number — Percentage of shares owned (greater than or equal to 25%), only for UBOs.
        - `hasOwnership` boolean — True if the person has at least 25% ownership of the business.
        - `hasControl` boolean — True if the person has a significant responsibility to control, manage, or direct the activities of the business. At least one of the ultimateBeneficialOwners needs to have this set to true.
        - `isSigner` boolean — True if the person can authorize transactions on behalf of the business. At least one of the ultimateBeneficialOwners needs to have this set to true.
        - `relationshipEstablishedAt` string, date — The date that the ultimateBeneficialOwners first became an owner, control person, or signer for the business in format yyyy-mm-dd.
        - `supplementaryInfo` string — This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
        - `supplementaryUrl` string — This field is designed to contain supplementary documents or files that can be uploaded as part of the KYC process. URL or Base64 encoded string of the file of the supplementary information. *If the file is base64 encoded, it must start with "data:" *Maximum file size 3MB and minimum file size 10KB *Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif
      - `proofOfAddressType` string
      - `proofOfAddressUrl` string
      - `certificateOfRegistrationDocType` string
      - `certificateOfRegistrationDocUrl` string
      - `certificateNumber` string
      - `businessRegistrationDocUrl` string
      - `registrationNumber` string
      - `licenseExpirationDate` string
      - `certificateOfIncorporationDocUrl` string
      - `incorporationNumber` string
      - `incorporationDate` string
      - `incorporationCountry` string
      - `incorporationState` string
      - `controlScheme` string
      - `shareStructureUrl` string
      - `constitutionOrAnnualReportUrl` string
      - `articlesOfAssociationUrl` string
      - `uboDeclarationUrl` string
      - `partnershipMinsOfMeetingUrl` string
      - `partnershipDeedUrl` string
      - `certificateOfIncumbencyUrl` string
      - `sourceOfFundsUrl` string
      - `organizationStructureUrl` string
      - `flowOfFundsUrl` string
      - `purpose` string
      - `productServiceCategory` string
      - `tradeName` string
      - `exportCountry` string
      - `tradeType` string
      - `sofEuQuestionnaire` SofEuKybQuestionnaire
        - `estimatedAnnualRevenueUsd` '0_99999' | '100000_999999' | '1000000_9999999' | '10000000_49999999' | '50000000_249999999' | '250000000_plus' — Estimated annual revenue in USD.
        - `expectedMonthlyPaymentsUsd` string — Expected monthly payments in USD.
        - `operatesInProhibitedCountries` boolean
        - `primaryPurpose` 'charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'other' | 'payments_to_friends_or_family_abroad' | 'payroll' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payments_for_goods_and_services' | 'tax_optimization' | 'third_party_money_transmission' | 'treasury_management' — What is the primary purpose of the business account?
        - `primaryPurposeOther` string — Required if the primary purpose is 'other'.
        - `highRiskActivities` string[] — List of high-risk activities the business is involved in.
        - `sourceOfFunds` 'business_loans' | 'grants' | 'inter_company_funds' | 'investment_proceeds' | 'legal_settlement' | 'owners_capital' | 'pension_retirement' | 'sale_of_assets' | 'sales_of_goods_and_services' | 'tax_refund' | 'third_party_funds' | 'treasury_reserves' — What is the source of funds for the business account?
        - `sourceOfFundsDescription` string — Description of the source of funds for the business' account.
        - `transmitsCustomerFunds` boolean — Specifies whether the business directly receives, holds, or sends customer funds to another party on behalf of its users. A value of true means the business is acting as a money transmitter and is subject to money transmission regulations in addition to general money service obligations.
        - `transmitsCustomerFundsDescription` string — Describes whether and how the business actively transmits customer funds. i.e., moves money from one party to another on behalf of a customer (e.g., sending, remitting, or transferring funds). This field should clarify the money-transmission activity performed.
        - `customerFundsDescription` string — Describes the nature of the customer funds handled by the business. This field explains the characteristics of the funds rather than the act of transmitting them.
        - `conductsMoneyServices` boolean — Indicates whether the business is engaged in providing money services as a line of business (e.g., money transmission, currency exchange, or other regulated financial activities). A value of true means the business is considered a Money Services Business (MSB) under applicable regulations and may be subject to AML, KYC, and licensing requirements.
      - `supplementaryInfo` string
      - `supplementaryUrl` string
      - `documents` DocumentObject[]
        - `type` string
        - `subType` string
        - `issuedCountry` string
        - `issuedDate` string, date
        - `expiryDate` string, date
        - `number` string
        - `description` string
        - `url` string
        - `fileId` string
        - `uboId` string

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/hifibridge/apis/hifi-api.md) · [All operations](https://skmtc.net/hifibridge/apis/hifi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hifibridge/hifi-api/revisions/74d9e530fbea/schema)