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.

UBO

PATCH https://api.synapsefi.com/v3.1/users/:user_id/ubo

This endpoint allows you to create a user document.

Headers

Name	Type	Description
X-SP-USER	string	OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

Name

Type

Description

X-SP-USER

string

OAuth key and device fingerprint, separated by a pipe.

X-SP-USER-IP

string

IP address of your device.

X-SP-GATEWAY

string

Your Client ID and Secret, separated by a pipe.

{
    "_id": "5fd7acfd8677040053ad486d",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d"
        }
    },
    "account_closure_date": null,
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "documents": [
        {
            "entity_scope": "Arts & Entertainment",
            "entity_type": "M",
            "id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
            "id_score": null,
            "is_active": true,
            "name": "Test User",
            "permission_scope": "UNVERIFIED",
            "physical_docs": [
                {
                    "document_type": "GOVT_ID",
                    "id": "6eccfe586819891542148c4d0f34692456e1013f936b2a06dc3533e498f04649",
                    "last_updated": 1607973508430,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "GOVT_ID_BACK",
                    "id": "968cdc737a7ea86b32f2068e96ed4cf2bdb3587237255c87dbe5808ffc52f1d5",
                    "last_updated": 1607973508618,
                    "status": "SUBMITTED|REVIEWING"
                }
            ],
            "required_edd_docs": [],
            "social_docs": [
                {
                    "document_type": "IP",
                    "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
                    "last_updated": 1607973508963,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "ADDRESS",
                    "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
                    "last_updated": 1607973509058,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "EMAIL",
                    "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
                    "last_updated": 1607973508501,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "DATE",
                    "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
                    "last_updated": 1607973509079,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "PHONE_NUMBER",
                    "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
                    "last_updated": 1607973508587,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "MAILING_ADDRESS",
                    "id": "6f819c2ed951bb4ada08269582055a81908794e5db4522feb74918641cc7bfd9",
                    "info": {
                        "address_care_of": "Some User",
                        "address_city": "SAN FRANCISCO",
                        "address_country_code": "US",
                        "address_postal_code": "94105",
                        "address_street": "101 2ND ST STE 1500",
                        "address_subdivision": "CA"
                    },
                    "last_updated": 1607973508486,
                    "status": "SUBMITTED|VALID"
                }
            ],
            "virtual_docs": [
                {
                    "document_type": "TIN",
                    "id": "a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
                    "last_updated": 1607973508424,
                    "status": "SUBMITTED|REVIEWING"
                }
            ],
            "watchlists": "NO_MATCH"
        }
    ],
    "emails": [],
    "extra": {
        "cip_tag": 1,
        "date_joined": 1607970040391,
        "extra_security": false,
        "is_business": false,
        "is_trusted": false,
        "last_updated": 1607973507271,
        "public_note": null,
        "supp_id": "122eddfgbeafrfvbbb"
    },
    "flag": "NOT-FLAGGED",
    "flag_code": null,
    "is_hidden": false,
    "legal_names": [
        "Test User"
    ],
    "logins": [
        {
            "email": "test@synapsepay.com",
            "scope": "READ_AND_WRITE"
        }
    ],
    "permission": "UNVERIFIED",
    "permission_code": null,
    "phone_numbers": [
        "901.942.8167"
    ],
    "photos": [],
    "refresh_token": "refresh_EXexC9GsR4o35jO7lIrKhWVcZv6PmAzYpQfFtU0i",
    "watchlists": "NO_MATCH"
}

{
    "error": {
        "code": "missing_client_credentials",
        "en": "Client credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

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

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
      }
   ]
}'

PreviousUpdate User NextManage Duplicates

Last updated 2 years ago