Update 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
PATCH https://api.synapsefi.com/v3.1/users/:user_id
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.
{
"_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
}Go to User Object Details to see all the required and optional body parameters allowed during user creation. Following are example requests:
Add a new Base Document
PATCH /v3.1/users/5fd7acfd8677040053ad486d 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
{
"documents": [
{
"email": "test@test.com",
"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"
}
}
]
}
]
}curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
--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 '{
"documents": [
{
"email": "test@test.com",
"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"
}
}
]
}
]
}'Update an Existing Base Document
PATCH /v3.1/users/5fd7acfd8677040053ad486d 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
{
"documents": [
{
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"email": "test@test.com",
"phone_number": "901.111.1111",
"virtual_docs": [
{
"id":"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
"document_value": "2222",
"document_type": "TIN",
"meta": {
"country_code": "US"
}
}
],
"physical_docs": [
{
"id":"6eccfe586819891542148c4d0f34692456e1013f936b2a06dc3533e498f04649",
"document_value": "data:image/gif;base64,SUQs==",
"document_type": "GOVT_ID",
"meta": {
"country_code": "US",
"state_code": "CA"
}
}
],
"social_docs": [
{
"id":"6f819c2ed951bb4ada08269582055a81908794e5db4522feb74918641cc7bfd9",
"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"
}
}
]
}
]
}curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
--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 '{
"documents": [
{
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"email": "test@test.com",
"phone_number": "901.111.1111",
"virtual_docs": [
{
"id":"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
"document_value": "2222",
"document_type": "TIN",
"meta": {
"country_code": "US"
}
}
],
"physical_docs": [
{
"id":"6eccfe586819891542148c4d0f34692456e1013f936b2a06dc3533e498f04649",
"document_value": "data:image/gif;base64,SUQs==",
"document_type": "GOVT_ID",
"meta": {
"country_code": "US",
"state_code": "CA"
}
}
],
"social_docs": [
{
"id":"6f819c2ed951bb4ada08269582055a81908794e5db4522feb74918641cc7bfd9",
"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"
}
}
]
}
]
}'Delete an Existing Base Document
PATCH /v3.1/users/5fd7acfd8677040053ad486d 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
{
"documents": [
{
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"permission_scope":"DELETE_DOCUMENT"
}
]
}curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
--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 '{
"documents": [
{
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"permission_scope":"DELETE_DOCUMENT"
}
]
}'////////Delete an Existing Sub Document
PATCH /v3.1/users/5fd7acfd8677040053ad486d 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
{
"documents": [
{
"id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
"social_docs": [
{
"id": "b5a4af45a00167bd44e43262ae89af7c1747ecb6b7292b3b9e92d8431f44e317",
"document_value": "901-942-8167",
"document_type": "DELETE_DOCUMENT"
}
]
}
]
}curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
--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 '{
"documents": [
{
"id": "64b01b1bb5eb17ae27aec9cb486bdee2c83e28acd0f99b5f900ecedf44c00a17",
"social_docs": [
{
"id": "4e8ffb81ab82dfd9f95341b9194bc430811a45782cf4ab4fa4e98b2eb4355782",
"document_value": "4600 MUELLER BLVD APT 3005, AUSTIN, TX, US, 78723",
"document_type": "DELETE_DOCUMENT"
}
]
}
]
}'////////Update User Permissions
PATCH /v3.1/users/5fd7acfd8677040053ad486d 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
{
"permission":"LOCKED",
"permission_code":"KYC_FRAUD|BLOCKED_LIST"
}curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
--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 '{
"permission":"LOCKED",
"permission_code":"KYC_FRAUD|BLOCKED_LIST"
}'Last updated