Update a UBO

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/ubos/{uboId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "OWNER_OR_OPERATOR",
  "roles": [
    "UBO"
  ],
  "businessTitle": "<string>",
  "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",
  "taxIdentificationNumber": "<string>",
  "taxResidenceCountry": "<string>",
  "govIdType": "PASSPORT",
  "govIdCountry": "<string>",
  "govIdNumber": "<string>",
  "govIdFrontUrl": "<string>",
  "govIdBackUrl": "<string>",
  "govIdIssuanceDate": "2023-12-25",
  "govIdExpirationDate": "2023-12-25",
  "govIdIssuanceAuthority": "<string>",
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "<string>",
  "authLetterUrl": "<string>",
  "shareProportion": 123,
  "hasOwnership": true,
  "hasControl": true,
  "isSigner": true,
  "relationshipEstablishedAt": "2023-12-25",
  "supplementaryInfo": "<string>",
  "supplementaryUrl": "<string>"
}'

{
  "id": "03aef9fa-0e58-4f42-a22f-46de619b42e0",
  "role": "OWNER_OR_OPERATOR",
  "roles": [
    "UBO",
    "DIRECTOR"
  ],
  "businessTitle": "CEO",
  "firstName": "John",
  "firstNameLocal": "John",
  "middleName": null,
  "middleNameLocal": null,
  "lastName": "Doe",
  "lastNameLocal": "Doe",
  "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": "NJ",
  "placeOfBirth": null,
  "gender": "M",
  "country": "USA",
  "taxIdentificationNumber": "123456789",
  "taxResidenceCountry": "USA",
  "ipAddress": null,
  "hasOwnership": true,
  "hasControl": true,
  "isSigner": true,
  "relationshipEstablishedAt": "2020-01-01",
  "govIdCountry": "USA",
  "govIdType": "PASSPORT",
  "govIdNumber": "123456789",
  "govIdFrontUrl": "https://example.com",
  "govIdBackUrl": "https://example.com",
  "govIdIssuanceDate": "2020-01-01",
  "govIdExpirationDate": "2027-01-01",
  "govIdIssuanceAuthority": null,
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "https://example.com",
  "authLetterUrl": "https://example.com",
  "shareProportion": 25,
  "supplementaryInfo": null,
  "supplementaryUrl": null,
  "documents": []
}

POST

users

{userId}

kyc

ubos

{uboId}

Update a UBO

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/ubos/{uboId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "OWNER_OR_OPERATOR",
  "roles": [
    "UBO"
  ],
  "businessTitle": "<string>",
  "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",
  "taxIdentificationNumber": "<string>",
  "taxResidenceCountry": "<string>",
  "govIdType": "PASSPORT",
  "govIdCountry": "<string>",
  "govIdNumber": "<string>",
  "govIdFrontUrl": "<string>",
  "govIdBackUrl": "<string>",
  "govIdIssuanceDate": "2023-12-25",
  "govIdExpirationDate": "2023-12-25",
  "govIdIssuanceAuthority": "<string>",
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "<string>",
  "authLetterUrl": "<string>",
  "shareProportion": 123,
  "hasOwnership": true,
  "hasControl": true,
  "isSigner": true,
  "relationshipEstablishedAt": "2023-12-25",
  "supplementaryInfo": "<string>",
  "supplementaryUrl": "<string>"
}'

{
  "id": "03aef9fa-0e58-4f42-a22f-46de619b42e0",
  "role": "OWNER_OR_OPERATOR",
  "roles": [
    "UBO",
    "DIRECTOR"
  ],
  "businessTitle": "CEO",
  "firstName": "John",
  "firstNameLocal": "John",
  "middleName": null,
  "middleNameLocal": null,
  "lastName": "Doe",
  "lastNameLocal": "Doe",
  "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": "NJ",
  "placeOfBirth": null,
  "gender": "M",
  "country": "USA",
  "taxIdentificationNumber": "123456789",
  "taxResidenceCountry": "USA",
  "ipAddress": null,
  "hasOwnership": true,
  "hasControl": true,
  "isSigner": true,
  "relationshipEstablishedAt": "2020-01-01",
  "govIdCountry": "USA",
  "govIdType": "PASSPORT",
  "govIdNumber": "123456789",
  "govIdFrontUrl": "https://example.com",
  "govIdBackUrl": "https://example.com",
  "govIdIssuanceDate": "2020-01-01",
  "govIdExpirationDate": "2027-01-01",
  "govIdIssuanceAuthority": null,
  "proofOfAddressType": "UTILITY_BILL",
  "proofOfAddressUrl": "https://example.com",
  "authLetterUrl": "https://example.com",
  "shareProportion": 25,
  "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

uboId

string

required

The ID of the Ultimate Beneficial Owner (UBO).

Body

application/json

role

enum<string>

deprecated

The role of the ubo in the business.

Available options:

OWNER_OR_OPERATOR,

PARTNER,

UBO,

DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP,

AGENT_OR_AUTHORISED_PERSON

roles

enum<string>[]

The roles of the ubo in the business.

Show child attributes

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.

string<email>

phone

string

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

placeOfBirth

string

gender

enum<string>

Available options:

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

enum<string>

Available options:

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

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.

*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

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

Response

Success

roles

enum<string>[]

required

The roles of the ubo in the business.

Show child attributes

firstName

string

required

first name in local language.

lastName

string

required

role

enum<string>

deprecated

The role of the ubo in the business.

Available options:

OWNER_OR_OPERATOR,

PARTNER,

UBO,

DIRECTOR_CONTROL_PERSON_OR_LEGAL_REP,

AGENT_OR_AUTHORISED_PERSON

businessTitle

string

Agent or authorised person‘s job title.

firstNameLocal

string

middleName

string

middleNameLocal

string

middle name in local language.

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>

phone

string

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

placeOfBirth

string

gender

enum<string>

Available options:

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

enum<string>

Available options:

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

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.

*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

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

Retrieve a UBO

List all documents

⌘I

Account

Virtual Account

Settlement Rules

Common

File

Kyc

Offramp

Crypto Transfer

Cross-Chain Bridge

Token Swap

Onramp

Transfer Approvals

User

Wallet

Update a UBO

Authorizations

Path Parameters

Body

Response