--- title: "Retrieve KYC information" method: GET path: "/v2/users/{userId}/kyc" tags: ["Kyc"] --- # Retrieve KYC information `GET /v2/users/{userId}/kyc` Get the KYC information the user currently holds. ## Path parameters - `userId` string, required ## 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)