v1
latestOpenAPI 3.0.02026-07-26103425558.9 KBAdd a UBO
Add a UBO to the user.
Path parameters
ID of the user
Request body
The role of the ubo in the business.
The roles of the ubo in the business.
Agent or authorised person‘s job title.
first name in local language.
middle name in local language.
last name in local language.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
Date of birth in format yyyy-mm-dd.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
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.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
Three-letter alpha-3 country code of the submitted government id as defined in the ISO 3166-1 spec.
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
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
The issue date of the Gov ID document in format yyyy-mm-dd.
The expiry date of the Gov ID document in format yyyy-mm-dd.
Issuing authority of the Gov ID document.
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
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.
True if the person has at least 25% ownership of the business.
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.
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.
The date that the ultimateBeneficialOwners first became an owner, control person, or signer for the business in format yyyy-mm-dd.
This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
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
The role of the ubo in the business.
The roles of the ubo in the business.
Agent or authorised person‘s job title.
first name in local language.
middle name in local language.
last name in local language.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
Date of birth in format yyyy-mm-dd.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
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.
Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.
Three-letter alpha-3 country code of the submitted government id as defined in the ISO 3166-1 spec.
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
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
The issue date of the Gov ID document in format yyyy-mm-dd.
The expiry date of the Gov ID document in format yyyy-mm-dd.
Issuing authority of the Gov ID document.
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
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.
True if the person has at least 25% ownership of the business.
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.
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.
The date that the ultimateBeneficialOwners first became an owner, control person, or signer for the business in format yyyy-mm-dd.
This field allows the inclusion of additional textual information or context that may be relevant to the KYC process.
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