Update User
Please not 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
User
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

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
4
X-SP-USER-IP: 255.127.79.76
5
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
6
Content-Type: application/json
7
8
{
9
"documents": [
10
{
11
"email": "[email protected]",
12
"phone_number": "901.111.1111",
13
"ip": "::1",
14
"name": "Test User",
15
"alias": "Test",
16
"entity_type": "M",
17
"entity_scope": "Arts & Entertainment",
18
"day": 2,
19
"month": 5,
20
"year": 1989,
21
"address_street": "1 Market St.",
22
"address_city": "SF",
23
"address_subdivision": "CA",
24
"address_postal_code": "94105",
25
"address_country_code": "US",
26
"virtual_docs": [
27
{
28
"document_value": "2222",
29
"document_type": "TIN",
30
"meta": {
31
"country_code": "US"
32
}
33
}
34
],
35
"physical_docs": [
36
{
37
"document_value": "data:image/gif;base64,SUQs==",
38
"document_type": "GOVT_ID",
39
"meta": {
40
"country_code": "US",
41
"state_code": "CA"
42
}
43
},
44
{
45
"document_value": "data:image/gif;base64,SUQs==",
46
"document_type": "GOVT_ID_BACK",
47
"meta": {
48
"country_code": "US",
49
"state_code": "CA"
50
}
51
}
52
],
53
"social_docs": [
54
{
55
"document_value": "101 2nd St. STE 1500 SF CA US 94105",
56
"document_type": "MAILING_ADDRESS",
57
"meta": {
58
"address_street": "101 2nd St STE 1500",
59
"address_city": "SF",
60
"address_subdivision": "CA",
61
"address_postal_code": "94105",
62
"address_country_code": "US",
63
"address_care_of": "Some User"
64
}
65
}
66
]
67
}
68
]
69
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
2
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
3
--header 'X-SP-USER-IP: 255.127.79.76' \
4
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
5
--header 'Content-Type: application/json' \
6
--data-raw '{
7
"documents": [
8
{
9
"email": "[email protected]",
10
"phone_number": "901.111.1111",
11
"ip": "::1",
12
"name": "Test User",
13
"alias": "Test",
14
"entity_type": "M",
15
"entity_scope": "Arts & Entertainment",
16
"day": 2,
17
"month": 5,
18
"year": 1989,
19
"address_street": "1 Market St.",
20
"address_city": "SF",
21
"address_subdivision": "CA",
22
"address_postal_code": "94105",
23
"address_country_code": "US",
24
"virtual_docs": [
25
{
26
"document_value": "2222",
27
"document_type": "TIN",
28
"meta": {
29
"country_code": "US"
30
}
31
}
32
],
33
"physical_docs": [
34
{
35
"document_value": "data:image/gif;base64,SUQs==",
36
"document_type": "GOVT_ID",
37
"meta": {
38
"country_code": "US",
39
"state_code": "CA"
40
}
41
},
42
{
43
"document_value": "data:image/gif;base64,SUQs==",
44
"document_type": "GOVT_ID_BACK",
45
"meta": {
46
"country_code": "US",
47
"state_code": "CA"
48
}
49
}
50
],
51
"social_docs": [
52
{
53
"document_value": "101 2nd St. STE 1500 SF CA US 94105",
54
"document_type": "MAILING_ADDRESS",
55
"meta": {
56
"address_street": "101 2nd St STE 1500",
57
"address_city": "SF",
58
"address_subdivision": "CA",
59
"address_postal_code": "94105",
60
"address_country_code": "US",
61
"address_care_of": "Some User"
62
}
63
}
64
]
65
}
66
]
67
}'
Copied!
1
Copied!
1
Copied!
1
Copied!
1
Copied!

Update an Existing Base Document

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
4
X-SP-USER-IP: 255.127.79.76
5
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
6
Content-Type: application/json
7
8
{
9
"documents": [
10
{
11
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
12
"email": "[email protected]",
13
"phone_number": "901.111.1111",
14
"virtual_docs": [
15
{
16
"id":"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
17
"document_value": "2222",
18
"document_type": "TIN",
19
"meta": {
20
"country_code": "US"
21
}
22
}
23
],
24
"physical_docs": [
25
{
26
"id":"6eccfe586819891542148c4d0f34692456e1013f936b2a06dc3533e498f04649",
27
"document_value": "data:image/gif;base64,SUQs==",
28
"document_type": "GOVT_ID",
29
"meta": {
30
"country_code": "US",
31
"state_code": "CA"
32
}
33
}
34
],
35
"social_docs": [
36
{
37
"id":"6f819c2ed951bb4ada08269582055a81908794e5db4522feb74918641cc7bfd9",
38
"document_value": "101 2nd St. STE 1500 SF CA US 94105",
39
"document_type": "MAILING_ADDRESS",
40
"meta": {
41
"address_street": "101 2nd St STE 1500",
42
"address_city": "SF",
43
"address_subdivision": "CA",
44
"address_postal_code": "94105",
45
"address_country_code": "US",
46
"address_care_of": "Some User"
47
}
48
}
49
]
50
}
51
]
52
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
2
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
3
--header 'X-SP-USER-IP: 255.127.79.76' \
4
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
5
--header 'Content-Type: application/json' \
6
--data-raw '{
7
"documents": [
8
{
9
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
10
"email": "[email protected]",
11
"phone_number": "901.111.1111",
12
"virtual_docs": [
13
{
14
"id":"a55cc12f46e8091f741b978d5fa556b2f8772a75007a82aae10a2fd810f644cb",
15
"document_value": "2222",
16
"document_type": "TIN",
17
"meta": {
18
"country_code": "US"
19
}
20
}
21
],
22
"physical_docs": [
23
{
24
"id":"6eccfe586819891542148c4d0f34692456e1013f936b2a06dc3533e498f04649",
25
"document_value": "data:image/gif;base64,SUQs==",
26
"document_type": "GOVT_ID",
27
"meta": {
28
"country_code": "US",
29
"state_code": "CA"
30
}
31
}
32
],
33
"social_docs": [
34
{
35
"id":"6f819c2ed951bb4ada08269582055a81908794e5db4522feb74918641cc7bfd9",
36
"document_value": "101 2nd St. STE 1500 SF CA US 94105",
37
"document_type": "MAILING_ADDRESS",
38
"meta": {
39
"address_street": "101 2nd St STE 1500",
40
"address_city": "SF",
41
"address_subdivision": "CA",
42
"address_postal_code": "94105",
43
"address_country_code": "US",
44
"address_care_of": "Some User"
45
}
46
}
47
]
48
}
49
]
50
}'
Copied!
1
Copied!
1
Copied!
1
Copied!
1
Copied!

Delete an Existing Base Document

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
4
X-SP-USER-IP: 255.127.79.76
5
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
6
Content-Type: application/json
7
8
{
9
"documents": [
10
{
11
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
12
"permission_scope":"DELETE_DOCUMENT"
13
}
14
]
15
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
2
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
3
--header 'X-SP-USER-IP: 255.127.79.76' \
4
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
5
--header 'Content-Type: application/json' \
6
--data-raw '{
7
"documents": [
8
{
9
"id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
10
"permission_scope":"DELETE_DOCUMENT"
11
}
12
]
13
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Delete an Existing Sub Document

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
4
X-SP-USER-IP: 255.127.79.76
5
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
6
Content-Type: application/json
7
8
{
9
"documents": [
10
{
11
"id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
12
"social_docs": [
13
{
14
"id": "b5a4af45a00167bd44e43262ae89af7c1747ecb6b7292b3b9e92d8431f44e317",
15
"document_value": "901-942-8167",
16
"document_type": "DELETE_DOCUMENT"
17
}
18
]
19
}
20
]
21
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
2
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
3
--header 'X-SP-USER-IP: 255.127.79.76' \
4
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
5
--header 'Content-Type: application/json' \
6
--data-raw '{
7
"documents": [
8
{
9
"id": "64b01b1bb5eb17ae27aec9cb486bdee2c83e28acd0f99b5f900ecedf44c00a17",
10
"social_docs": [
11
{
12
"id": "4e8ffb81ab82dfd9f95341b9194bc430811a45782cf4ab4fa4e98b2eb4355782",
13
"document_value": "4600 MUELLER BLVD APT 3005, AUSTIN, TX, US, 78723",
14
"document_type": "DELETE_DOCUMENT"
15
}
16
]
17
}
18
]
19
}'
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!
1
//
Copied!

Update User Permissions

HTTP
cURL
Python
JS
PHP
GO
1
PATCH /v3.1/users/5fd7acfd8677040053ad486d HTTP/1.1
2
Host: uat-api.synapsefi.com
3
X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW
4
X-SP-USER-IP: 255.127.79.76
5
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
6
Content-Type: application/json
7
8
{
9
"permission":"LOCKED",
10
"permission_code":"KYC_FRAUD|BLOCKED_LIST"
11
}
Copied!
1
curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d' \
2
--header 'X-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_6zZVr8biuqGkyo9IxMO5jY2QlSp0nmD4EBAgKcJW' \
3
--header 'X-SP-USER-IP: 255.127.79.76' \
4
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
5
--header 'Content-Type: application/json' \
6
--data-raw '{
7
"permission":"LOCKED",
8
"permission_code":"KYC_FRAUD|BLOCKED_LIST"
9
}'
Copied!
1
Copied!
1
Copied!
1
Copied!
1
Copied!
Last modified 3mo ago