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.

User

POST https://api.synapsefi.com/v3.1/users

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. For this request OAuth can be left blank since X-SP-GATEWAY will be used for authentication. But device fingerprint is still required.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 User Successfully Created.

{
    "_id": "5faa6d8304707a86251024e6",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5faa6d8304707a86251024e6"
        }
    },
    "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_BACK",
                    "id": "d17b740787a4311e74c9f5f8e5edeb726911bfeb5ed050de74c12f427265c0f9",
                    "last_updated": 1605004672416,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "GOVT_ID",
                    "id": "1612b3afdc2c0a531165aea84725341492df40af3088037ba9ca6c2fad8e76cd",
                    "last_updated": 1605004672385,
                    "status": "SUBMITTED|REVIEWING"
                }
            ],
            "required_edd_docs": [],
            "social_docs": [
                {
                    "document_type": "EMAIL",
                    "id": "2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741",
                    "last_updated": 1605004672431,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "PHONE_NUMBER",
                    "id": "fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f",
                    "last_updated": 1605004672441,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "ADDRESS",
                    "id": "c615c761d68c578a98fde8e73c490df405ff5d5e34fc11f029660d7e9743df21",
                    "last_updated": 1605004672472,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "IP",
                    "id": "28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a",
                    "last_updated": 1605004672457,
                    "status": "SUBMITTED|REVIEWING"
                },
                {
                    "document_type": "DATE",
                    "id": "2b52edae636ca2fbe12ab1b08a344d381dabc3d2b92844cf7a8d8b6052b26d8e",
                    "last_updated": 1605004672588,
                    "status": "SUBMITTED|REVIEWING"
                }
            ],
            "virtual_docs": [
                {
                    "document_type": "SSN",
                    "id": "ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f",
                    "last_updated": 1605004672365,
                    "status": "SUBMITTED|REVIEWING"
                }
            ],
            "watchlists": "PENDING"
        }
    ],
    "emails": [],
    "extra": {
        "cip_tag": 1,
        "date_joined": 1605004671094,
        "extra_security": false,
        "is_business": false,
        "is_trusted": false,
        "last_updated": 1605004671094,
        "public_note": null,
        "supp_id": "122eddfgbeafrfvbbb"
    },
    "flag": "NOT-FLAGGED",
    "flag_code": null,
    "is_hidden": false,
    "legal_names": [
        "Test User"
    ],
    "logins": [
        {
            "email": "[e-mail]",
            "scope": "READ_AND_WRITE"
        }
    ],
    "permission": "UNVERIFIED",
    "permission_code": null,
    "phone_numbers": [
        "901.111.1111"
    ],
    "photos": [],
    "refresh_token": "refresh_fsUlnTdLVaXirmB0RuEDJzP9WyOSCIhF0543HQex",
    "watchlists": "PENDING"
}

400 Request Failing.

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

Go to User Object Details to see all the required and optional body parameters allowed during user creation.

Example Request

HTTP

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": "[e-mail]",
      "password":"TestTest123$"
    }
  ],
  "phone_numbers": [
    "901.111.1111"
  ],
  "legal_names": [
    "Test User"
  ],
  "documents":[{
        "email":"[e-mail]",
        "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

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": "[e-mail]",
      "password":"TestTest123$"
    }
  ],
  "phone_numbers": [
    "901.111.1111"
  ],
  "legal_names": [
    "Test User"
  ],
  "documents":[{
        "email":"[e-mail]",
        "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
  }
}'

Python

JS

PHP

GO

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.