HIFI Developer Docs

Retrieve KYC information

curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc \
  --header 'Authorization: Bearer <token>'

{
  "userId": "35dbc7ea-2877-4a70-add6-b5458289df23",
  "kycInfo": {
    "type": "individual",
    "firstName": "John",
    "firstNameLocal": "Lil John",
    "middleName": null,
    "middleNameLocal": null,
    "lastName": "Doe",
    "lastNameLocal": null,
    "nationality": "USA",
    "email": "[email protected]",
    "phone": "+12223334444",
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": null,
      "city": "San Francisco",
      "stateProvinceRegion": "CA",
      "postalCode": "94105",
      "country": "USA"
    },
    "dateOfBirth": "1990-01-01",
    "countryOfBirth": "USA",
    "stateOfBirth": "NY",
    "placeOfBirth": null,
    "taxIdentificationNumber": "123456789",
    "taxResidenceCountry": "USA",
    "govIdType": "PASSPORT",
    "govIdNumber": "123456789",
    "govIdFrontUrl": "https://example.com",
    "govIdBackUrl": "https://example.com",
    "govIdCountry": "USA",
    "govIdIssuanceDate": "2020-01-01",
    "govIdExpirationDate": "2027-01-01",
    "govIdIssuanceAuthority": null,
    "govIdHandHoldUrl": "https://example.com",
    "proofOfAddressType": "UTILITY_BILL",
    "proofOfAddressUrl": "https://example.com",
    "sofEuQuestionnaire": null,
    "ipAddress": "108.28.159.21",
    "idType": "NIN",
    "idNumber": "123456789",
    "additionalIdType": null,
    "additionalIdNumber": null,
    "purpose": null,
    "productServiceCategory": null,
    "supplementaryInfo": null,
    "supplementaryUrl": null,
    "documents": []
  }
}

GET

users

{userId}

kyc

Retrieve KYC information

curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc \
  --header 'Authorization: Bearer <token>'

{
  "userId": "35dbc7ea-2877-4a70-add6-b5458289df23",
  "kycInfo": {
    "type": "individual",
    "firstName": "John",
    "firstNameLocal": "Lil John",
    "middleName": null,
    "middleNameLocal": null,
    "lastName": "Doe",
    "lastNameLocal": null,
    "nationality": "USA",
    "email": "[email protected]",
    "phone": "+12223334444",
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": null,
      "city": "San Francisco",
      "stateProvinceRegion": "CA",
      "postalCode": "94105",
      "country": "USA"
    },
    "dateOfBirth": "1990-01-01",
    "countryOfBirth": "USA",
    "stateOfBirth": "NY",
    "placeOfBirth": null,
    "taxIdentificationNumber": "123456789",
    "taxResidenceCountry": "USA",
    "govIdType": "PASSPORT",
    "govIdNumber": "123456789",
    "govIdFrontUrl": "https://example.com",
    "govIdBackUrl": "https://example.com",
    "govIdCountry": "USA",
    "govIdIssuanceDate": "2020-01-01",
    "govIdExpirationDate": "2027-01-01",
    "govIdIssuanceAuthority": null,
    "govIdHandHoldUrl": "https://example.com",
    "proofOfAddressType": "UTILITY_BILL",
    "proofOfAddressUrl": "https://example.com",
    "sofEuQuestionnaire": null,
    "ipAddress": "108.28.159.21",
    "idType": "NIN",
    "idNumber": "123456789",
    "additionalIdType": null,
    "additionalIdNumber": null,
    "purpose": null,
    "productServiceCategory": null,
    "supplementaryInfo": null,
    "supplementaryUrl": null,
    "documents": []
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId

string

required

ID of the user

Response

Success

KYC Object (Individual)
KYC Object (Business)

userId

string<uuid>

kycInfo

object

Show child attributes

kycInfo.type

enum<string>

Available options:

individual

kycInfo.firstName

string

kycInfo.firstNameLocal

string

kycInfo.middleName

string

kycInfo.middleNameLocal

string

kycInfo.lastName

string

kycInfo.lastNameLocal

string

kycInfo.nationality

string

kycInfo.email

string<email>

kycInfo.phone

string

kycInfo.address

object

Show child attributes

kycInfo.address.addressLine1

string

required

kycInfo.address.city

string

required

kycInfo.address.stateProvinceRegion

string

required

The second part of the ISO 3166-2 subdivision code. This must be provided if the country has subdivisions.

An ISO 3166-2 code consists of two parts, separated by a hyphen (-):

The first part is the ISO 3166-1 alpha-2 code of the country (e.g., US, CA, BR);
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).

kycInfo.address.postalCode

string

required

Must be supplied for countries that use postal codes.

kycInfo.address.country

string

required

Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.

kycInfo.address.addressLine2

string

kycInfo.dateOfBirth

string

kycInfo.countryOfBirth

string

kycInfo.stateOfBirth

string

kycInfo.placeOfBirth

string

kycInfo.gender

string

kycInfo.country

string

kycInfo.taxIdentificationNumber

string

kycInfo.taxResidenceCountry

string

kycInfo.govIdType

string

kycInfo.govIdFrontUrl

string

kycInfo.govIdBackUrl

string

kycInfo.govIdCountry

string

kycInfo.govIdNumber

string

kycInfo.govIdIssuanceDate

string

kycInfo.govIdExpirationDate

string

kycInfo.govIdIssuanceAuthority

string

kycInfo.govIdHandHoldUrl

string

kycInfo.proofOfAddressType

string

kycInfo.proofOfAddressUrl

string

kycInfo.sofEuQuestionnaire

object

Show child attributes

kycInfo.sofEuQuestionnaire.actingAsIntermediary

boolean

Is the customer acting as an intermediary for a third party?

kycInfo.sofEuQuestionnaire.employmentStatus

enum<string>

What is the customer's current employment status?

Available options:

employed,

homemaker,

retired,

self_employed,

student,

unemployed

kycInfo.sofEuQuestionnaire.expectedMonthlyPayments

enum<string>

What is the expected monthly volume of payments the customer will be sending or receiving?

Available options:

0_4999,

5000_9999,

10000_49999,

50000_plus

kycInfo.sofEuQuestionnaire.mostRecentOccupation

string

What is the customer's most recent occupation? Specify the relevant alphanumeric occupation code. See the list of occupations for the complete list of valid occupations and codes.

kycInfo.sofEuQuestionnaire.primaryPurpose

enum<string>

What is the primary purpose of the customer's account?

Available options:

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

kycInfo.sofEuQuestionnaire.primaryPurposeOther

string

Required if the primary purpose is 'other'.

kycInfo.sofEuQuestionnaire.sourceOfFunds

enum<string>

What is the source of funds for the customer's account?

Available options:

company_funds,

ecommerce_reseller,

gambling_proceeds,

gifts,

government_benefits,

inheritance,

investments_loans,

pension_retirement,

salary,

sale_of_assets_real_estate,

savings,

someone_elses_funds

kycInfo.ipAddress

string

kycInfo.idType

string

kycInfo.idNumber

string

kycInfo.additionalIdType

string

kycInfo.additionalIdNumber

string

kycInfo.purpose

string

kycInfo.productServiceCategory

string

kycInfo.supplementaryInfo

string

kycInfo.supplementaryUrl

string

kycInfo.documents

Document Object · object[]

Show child attributes

kycInfo.documents.type

string

kycInfo.documents.subType

string

kycInfo.documents.issuedCountry

string

kycInfo.documents.issuedDate

string<date>

kycInfo.documents.expiryDate

string<date>

kycInfo.documents.number

string

kycInfo.documents.description

string

kycInfo.documents.url

string

deprecated

kycInfo.documents.fileId

string

kycInfo.documents.uboId

string

List all KYC statuses

Retrieve KYC status

⌘I

Overview

Endpoints

Retrieve KYC information

Authorizations

Path Parameters

Response