Skip to main content
GET
/
v2
/
users
/
{userId}
/
kyc
/
requirements
Retrieve KYC requirements
curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/requirements \
  --header 'Authorization: Bearer <token>'
{
"userId": "35dbc7ea-2877-4a70-add6-b5458289df23",
"rails": "USD",
"type": "business",
"required": {
"businessName": "string",
"businessType": "string",
"businessIndustry": "string",
"registrationNumber": "string",
"registeredAddress": "object",
"address": {
"required": {
"addressLine1": "string",
"city": "string",
"stateProvinceRegion": "string",
"postalCode": "string",
"country": "string"
},
"optional": {
"addressLine2": "string"
}
},
"website": "string",
"incorporationDate": "date",
"email": "string",
"phone": "string",
"taxIdentificationNumber": "string",
"sofEuQuestionnaire": {
"required": {
"primaryPurpose": "string",
"sourceOfFunds": "string",
"transmitsCustomerFunds": "boolean",
"conductsMoneyServices": "boolean",
"highRiskActivities": "array",
"estimatedAnnualRevenueUsd": "string",
"expectedMonthlyPaymentsUsd": "string",
"customerFundsDescription": "string"
},
"optional": {
"operatesInProhibitedCountries": "string",
"primaryPurposeOther": "string",
"sourceOfFundsDescription": "string",
"transmitsCustomerFundsDescription": "string"
}
},
"ultimateBeneficialOwners": [
{
"required": {
"roles": "array",
"businessTitle": "string",
"firstName": "string",
"lastName": "string",
"nationality": "string",
"email": "string",
"phone": "string",
"address": {
"required": {
"addressLine1": "string",
"city": "string",
"stateProvinceRegion": "string",
"postalCode": "string",
"country": "string"
},
"optional": {
"addressLine2": "string"
}
},
"taxIdentificationNumber": "string",
"dateOfBirth": "date",
"shareProportion": "string",
"relationshipEstablishedAt": "date",
"documents": {
"identity": {
"minCount": 1,
"acceptedDocTypes": [
"DRIVERS",
"ID_CARD",
"PASSPORT",
"RESIDENCE_PERMIT"
]
}
}
},
"optional": {
"middleName": "string"
}
}
],
"documents": {
"legalPresence": {
"minCount": 1,
"acceptedDocTypes": [
"INCORPORATION_ARTICLES",
"INCORPORATION_CERT",
"STATE_REGISTRY"
]
},
"ownershipStructure": {
"minCount": 1,
"acceptedDocTypes": [
"SHAREHOLDER_REGISTRY",
"TRUST_AGREEMENT",
"INFORMATION_STATEMENT",
"STATE_REGISTRY"
]
},
"companyDetails": {
"minCount": 1,
"acceptedDocTypes": [
"PROOF_OF_ADDRESS"
]
},
"controlStructure": {
"minCount": 1,
"acceptedDocTypes": [
"DIRECTORS_REGISTRY",
"TRUST_AGREEMENT",
"INFORMATION_STATEMENT",
"STATE_REGISTRY"
]
}
}
},
"optional": {
"incorporationCountry": "string",
"incorporationState": "string"
},
"invalid": {}
}

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

Query Parameters

rails
enum<string>
required

The type of rail.

Available options:
USD,
SOUTH_AMERICA_STANDARD,
AFRICA_GENERAL,
AFRICA_NIGERIA,
GLOBAL_NETWORK

Response

Success

  • KYC Requirement Object (USD - Business)
  • KYC Requirement Object (USD - Individual)
userId
string<uuid>
rails
enum<string>

The type of rail.

Available options:
USD,
SOUTH_AMERICA_STANDARD,
AFRICA_GENERAL,
AFRICA_NIGERIA,
GLOBAL_NETWORK
type
enum<string>
Available options:
business
required
object

KYC fields required for this rail. The required fields varies based on the Rail.

optional
object

KYC fields that are optional for this rail. The optional fields varies based on the Rail.

invalid
object

KYC fields the user currently holds that are either missing or invalid for this rail. The specific invalid fields vary depending on the user’s current KYC data.

I