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": "jsmith@example.com",
  "phone": "<string>",
  "address": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<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": [
    "<any>"
  ],
  "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": "example@gmail.com",
    "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": "jsmith@example.com",
  "phone": "<string>",
  "address": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<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": [
    "<any>"
  ],
  "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": "example@gmail.com",
    "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

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

object

Source of Funds and Expected Use Questionnaire

Show child attributes

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

any[]

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

Retrieve KYC information

Retrieve KYC requirements

⌘I

Account

Virtual Account

Settlement Rules

Common

File

Kyc

Offramp

Crypto Transfer

Cross-Chain Bridge

Token Swap

Onramp

Transfer Approvals

User

Wallet

Update KYC information

Authorizations

Path Parameters

Body

Response