Create User

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.
post
https://api.synapsefi.com
/v3.1/users
User
Go to User Object Details to see all the required and optional body parameters allowed during user creation. 
Example Request
HTTP
cURL
Python
JS
PHP
GO
POST /v3.1/users HTTP/1.1
Host: https://uat-api.synapsefi.com
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
X-SP-USER-IP: 255.127.79.76
X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
​
 {
  "logins": [
    {
      "email": "[email protected]",
      "password":"TestTest123$"
    }
  ],
  "phone_numbers": [
    "901.111.1111"
  ],
  "legal_names": [
    "Test User"
  ],
  "documents":[{
        "email":"[email protected]",
        "phone_number":"901.111.1111",
        "ip":"::1",
        "name":"Test User",
        "alias":"Test",
        "entity_type":"M",
        "entity_scope":"Arts & Entertainment",
        "day":2,
        "month":5,
        "year":1989,
        "address_street":"1 Market St.",
        "address_city":"SF",
        "address_subdivision":"CA",
        "address_postal_code":"94105",
        "address_country_code":"US",
        "virtual_docs":[{
            "document_value":"2222",
            "document_type":"TIN",
            "meta":{
                "country_code":"US"
            }
        }],
        "physical_docs":[{
            "document_value": "data:image/gif;base64,SUQs==",
            "document_type": "GOVT_ID",
            "meta":{
                "country_code":"US",
                "state_code":"CA"
            }
        },
        {
            "document_value": "data:image/gif;base64,SUQs==",
            "document_type": "GOVT_ID_BACK",
            "meta":{
                "country_code":"US",
                "state_code":"CA"
            }
        }],
        "social_docs":[{
            "document_value": "101 2nd St. STE 1500 SF CA US 94105",
            "document_type": "MAILING_ADDRESS",
            "meta":{
                "address_street":"101 2nd St STE 1500",
                "address_city":"SF",
                "address_subdivision":"CA",
                "address_postal_code":"94105",
                "address_country_code":"US",
                "address_care_of":"Some User"
            }
        }]
    }],
  "extra": {
    "supp_id": "122eddfgbeafrfvbbb",
    "cip_tag":1,
    "is_business": false
  }
}
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users' \
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: |e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw ' {
  "logins": [
    {
      "email": "[email protected]",
      "password":"TestTest123$"
    }
  ],
  "phone_numbers": [
    "901.111.1111"
  ],
  "legal_names": [
    "Test User"
  ],
  "documents":[{
        "email":"[email protected]",
        "phone_number":"901.111.1111",
        "ip":"::1",
        "name":"Test User",
        "alias":"Test",
        "entity_type":"M",
        "entity_scope":"Arts & Entertainment",
        "day":2,
        "month":5,
        "year":1989,
        "address_street":"1 Market St.",
        "address_city":"SF",
        "address_subdivision":"CA",
        "address_postal_code":"94105",
        "address_country_code":"US",
        "virtual_docs":[{
            "document_value":"2222",
            "document_type":"TIN",
            "meta":{
                "country_code":"US"
            }
        }],
        "physical_docs":[{
            "document_value": "data:image/gif;base64,SUQs==",
            "document_type": "GOVT_ID",
            "meta":{
                "country_code":"US",
                "state_code":"CA"
            }
        },
        {
            "document_value": "data:image/gif;base64,SUQs==",
            "document_type": "GOVT_ID_BACK",
            "meta":{
                "country_code":"US",
                "state_code":"CA"
            }
        }],
        "social_docs":[{
            "document_value": "101 2nd St. STE 1500 SF CA US 94105",
            "document_type": "MAILING_ADDRESS",
            "meta":{
                "address_street":"101 2nd St STE 1500",
                "address_city":"SF",
                "address_subdivision":"CA",
                "address_postal_code":"94105",
                "address_country_code":"US",
                "address_care_of":"Some User"
            }
        }]
    }],
  "extra": {
    "supp_id": "122eddfgbeafrfvbbb",
    "cip_tag":1,
    "is_business": false
  }
}'
​
​
​
​
Verifying Addresses
We validate addresses to ensure an address is mailable. Prior to submitting an address, we encourage you to Verify Address. We also recommend that you use Google Maps, the USPS ZIP Code Lookup Tool or similar tools to autocomplete addresses prior to verifying. This should reduce the risk of submitting improperly formatted addresses.
View User
Update User
Last modified 1yr ago