Generate UBO Doc

Needed for Business Users Only.

UBO or Ultimate Beneficial Owner documents is used to declare who is the ultimate beneficial owner of a business or major shareholder.
Please note that both POST and PATCH calls on the user document perform various asynchronous operations. So it's not recommended to make subsequent POST and then PATCH requests on the same user document as that can lead to various race conditions. We recommend submitting all documents at once vs performing subsequent operations on the same document.
patch
https://api.synapsefi.com
/v3.1/users/:user_id/ubo
UBO
Body Details
Key
Type
Required
Description
entity_info
Object
Yes
Information about the business. Go to Entity Info Details to learn more.
signer.document_id
String
Yes
Document ID of the base document of the signer.
signer.relationship_to_entity
String
Yes
Relationship of the signer with the entity. Eg. CEO, CRO, etc.
compliance_contact.document_id
String
Yes
Document ID of the base document of the compliance contact.
compliance_contact.relationship_to_entity
String
Yes
Relationship of the compliance contact with the entity. Eg. CEO, CCO, etc.
primary_controlling_contact.document_id
String
Yes
Document ID of the base document of the primary controlling contact.
primary_controlling_contact.relationship_to_entity
String
Yes
Relationship of the primary controlling contact with the entity. Eg. CEO, CCO, etc.
owners.document_id
String
Yes
Document ID of the base document of the owner.
owners.title
String
Yes
Relationship of the owner with the entity. Eg. CEO, CCO, etc.
owners.ownership
Number
Yes
Percentage ownership of the owner.
attested*
boolean
Yes
Certification and Agreement to Notify
See below
*attested signifies the following statement is true:

I certify that the following information was submitted to Platform for all beneficial owners (holding 25% or more ownership) and controlling persons & executives: 
US Person(s): SSN + US Government Issued Photo ID 
Foreign Person(s): Tax Identification Number (if available) + Passport Number & Country of Issuance. In lieu of passport number, foreign persons may also provide an alien identification card number, or number and country of issuance of any other government issued photo ID evidencing nationality or residence.
Entity Info Details
Key
Type
Required
Description
document_id
String
Yes
Document ID of the base document of the entity.
cryptocurrency
Boolean
Yes
Set as false if business is not involved with cryptocurrency.
msb.federal
Boolean
Yes
Set as false if business does not have Money Transmission Licenses (MTL) in any states.
msb.states
List of String
Yes
List of states that business has Money Transmission Licenses (MTL) in.
public_company
Boolean
Yes
Set as false if business is not a public company.
majority_owned_by_listed
String
Yes
Set as false if business is not majority owned (50% or more) by a public company.
registered_SEC
String
Yes
Set as false if business is not registered with U.S. Securities and Exchange Commission (SEC).
regulated_financial
String
Yes
Set as false if business is not a regulated financial company.
gambling
String
Yes
Set as false if business is not involved with the internet gambling business.
Example Request
HTTP
cURL
Python
JS
PHP
GO
PATCH /v3.1/users/5fd7acfd8677040053ad486d/ubo HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
​
{
   "entity_info": {
      "cryptocurrency": true,
      "msb": {
         "federal": true,
         "states": ["AL"]
      },
      "public_company": false,
      "majority_owned_by_listed": false,
      "registered_SEC": false,
      "regulated_financial": false,
      "gambling": false,
      "document_id": "0162ac7bf11e873b33f3718c200999e341f6ff8e89482e8ed50e0d53a4d7cefa"
   },
   "signer": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "compliance_contact": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "primary_controlling_contact": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "owners": [
      {
         "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
         "title": "CEO",
         "ownership": 95
      }
   ],
   "attested": true
}
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/ubo' \
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
   "entity_info": {
      "cryptocurrency": true,
      "msb": {
         "federal": true,
         "states": ["AL"]
      },
      "public_company": false,
      "majority_owned_by_listed": false,
      "registered_SEC": false,
      "regulated_financial": false,
      "gambling": false,
      "document_id": "0162ac7bf11e873b33f3718c200999e341f6ff8e89482e8ed50e0d53a4d7cefa"
   },
   "signer": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "compliance_contact": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "primary_controlling_contact": {
      "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
      "relationship_to_entity": "CEO"
   },
   "owners": [
      {
         "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
         "title": "CEO",
         "ownership": 95
      }
   ]
}'
​
​
​
​

Update User

Manage Duplicates

Last modified 7mo ago

Key	Type	Required	Description
`entity_info`	Object	Yes	Information about the business. Go to Entity Info Details to learn more.
`signer.document_id`	String	Yes	Document ID of the base document of the signer.
`signer.relationship_to_entity`	String	Yes	Relationship of the signer with the entity. Eg. `CEO`, `CRO`, etc.
`compliance_contact.document_id`	String	Yes	Document ID of the base document of the compliance contact.
`compliance_contact.relationship_to_entity`	String	Yes	Relationship of the compliance contact with the entity. Eg. `CEO`, `CCO`, etc.
`primary_controlling_contact.document_id`	String	Yes	Document ID of the base document of the primary controlling contact.
`primary_controlling_contact.relationship_to_entity`	String	Yes	Relationship of the primary controlling contact with the entity. Eg. `CEO`, `CCO`, etc.
`owners.document_id`	String	Yes	Document ID of the base document of the owner.
`owners.title`	String	Yes	Relationship of the owner with the entity. Eg. `CEO`, `CCO`, etc.
`owners.ownership`	Number	Yes	Percentage ownership of the owner.
`attested*`	boolean	Yes	Certification and Agreement to Notify See below