HIFI Developer Docs

Update KYC information

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "firstNameLocal": "<string>",
  "middleName": "<string>",
  "middleNameLocal": "<string>",
  "lastName": "<string>",
  "lastNameLocal": "<string>",
  "nationality": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "address": {
    "addressLine1": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressLine2": "<string>"
  },
  "dateOfBirth": "2023-12-25",
  "countryOfBirth": "<string>",
  "stateOfBirth": "<string>",
  "placeOfBirth": "<string>",
  "gender": "M",
  "country": "<string>",
  "taxIdentificationNumber": "<string>",
  "taxResidenceCountry": "<string>",
  "ipAddress": "127.0.0.1",
  "govIdType": "PASSPORT",
  "govIdFrontUrl": "<string>",
  "govIdBackUrl": "<string>",
  "govIdCountry": "<string>",
  "govIdNumber": "<string>",
  "govIdIssuanceDate": "2023-12-25",
  "govIdExpirationDate": "2023-12-25",
  "govIdIssuanceAuthority": "<string>",
  "govIdHandHoldUrl": "<string>",
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "<string>",
  "sofEuQuestionnaire": {
    "actingAsIntermediary": true,
    "employmentStatus": "employed",
    "expectedMonthlyPayments": "0_4999",
    "mostRecentOccupation": "<string>",
    "primaryPurpose": "charitable_donations",
    "primaryPurposeOther": "<string>",
    "sourceOfFunds": "company_funds"
  },
  "idType": "PASSPORT",
  "idNumber": "<string>",
  "additionalIdType": "<string>",
  "additionalIdNumber": "<string>",
  "purpose": "<array>",
  "productServiceCategory": "<string>",
  "supplementaryInfo": "<string>",
  "supplementaryUrl": "<string>"
}
'

{
  "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": []
  }
}

POST

users

{userId}

kyc

Update KYC information

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "firstNameLocal": "<string>",
  "middleName": "<string>",
  "middleNameLocal": "<string>",
  "lastName": "<string>",
  "lastNameLocal": "<string>",
  "nationality": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "address": {
    "addressLine1": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressLine2": "<string>"
  },
  "dateOfBirth": "2023-12-25",
  "countryOfBirth": "<string>",
  "stateOfBirth": "<string>",
  "placeOfBirth": "<string>",
  "gender": "M",
  "country": "<string>",
  "taxIdentificationNumber": "<string>",
  "taxResidenceCountry": "<string>",
  "ipAddress": "127.0.0.1",
  "govIdType": "PASSPORT",
  "govIdFrontUrl": "<string>",
  "govIdBackUrl": "<string>",
  "govIdCountry": "<string>",
  "govIdNumber": "<string>",
  "govIdIssuanceDate": "2023-12-25",
  "govIdExpirationDate": "2023-12-25",
  "govIdIssuanceAuthority": "<string>",
  "govIdHandHoldUrl": "<string>",
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "<string>",
  "sofEuQuestionnaire": {
    "actingAsIntermediary": true,
    "employmentStatus": "employed",
    "expectedMonthlyPayments": "0_4999",
    "mostRecentOccupation": "<string>",
    "primaryPurpose": "charitable_donations",
    "primaryPurposeOther": "<string>",
    "sourceOfFunds": "company_funds"
  },
  "idType": "PASSPORT",
  "idNumber": "<string>",
  "additionalIdType": "<string>",
  "additionalIdNumber": "<string>",
  "purpose": "<array>",
  "productServiceCategory": "<string>",
  "supplementaryInfo": "<string>",
  "supplementaryUrl": "<string>"
}
'

{
  "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

Body

application/json

Update Individual User KYC
Update Business User KYC

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.

string<email>

E-mail address for compliance-related communications.

phone

string

Phone number in E.164 format "+12223334444".

address

object

Address of the user.

Show child attributes

address.addressLine1

string

required

address.city

string

required

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).

address.postalCode

string

required

Must be supplied for countries that use postal codes.

address.country

string

required

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

address.addressLine2

string

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

enum<string>

Available options:

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 for the list of unsupported countries/states.)

govIdType

enum<string>

Available options:

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

enum<string>

Available options:

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 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

Source of Funds and Expected Use Questionnaire · object

Source of Funds and Expected Use Questionnaire

Show child attributes

sofEuQuestionnaire.actingAsIntermediary

boolean

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

sofEuQuestionnaire.employmentStatus

enum<string>

What is the customer's current employment status?

Available options:

employed,

homemaker,

retired,

self_employed,

student,

unemployed

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

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.

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

sofEuQuestionnaire.primaryPurposeOther

string

Required if the primary purpose is 'other'.

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

idType

enum<string>

Available options:

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

array

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.

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.

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

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

Generate a KYC link

Submit KYC

⌘I

Overview

Endpoints

Update KYC information

Authorizations

Path Parameters

Body

Response