get https://uat-api.synapsefi.com/v3.1/users/?full_dehydrate=yes
Return all available user information including address information, screening results, etc.
Prerequisite to Using This API Call
Your platform will need to have purchased the "KYC and Sanctions" data service as part of its contract with Synapse in order to use the View User w/ Full Dehydrate call.
User Object (Full Dehydrate)
| Key | Type | Description |
|---|---|---|
| _id | string | Object ID of the user |
| _links.self.href | string | HAL-style link for the user object |
| client.id | string | ID of the client that created the user |
| client.name | string | Name of the client that created the user |
| documents[] | array of objects | List of Base Document Objects |
| extra.cip_tag | integer | Customer Identification Program number |
| extra.date_joined | integer | Date user joined (milliseconds since Unix epoch time) |
| extra.is_business | boolean | Flag for businesses |
| extra.is_trusted | boolean | Flag for trusted users |
| extra.last_updated | integer | Date user was last updated (milliseconds since Unix epoch time). |
| extra.note | string | Internal note field set by Synapse for the user. For instance, if a user account was closed this field will contain the closure reason listed above (e.g. "CLOSED due to duplicate Name and Email” or “CLOSED due to duplicate SSN” or "CLOSED due to duplicate TIN”). |
| extra.public_note | string | Additional note field set by the platform. |
| extra.supp_id | string | Additional ID to assign to the node |
| legal_names | array of strings | Legal names associated with the user |
| logins[] | array of objects | List of login objects |
| permission | string | See User Permissions for more information. |
| permission_code | string | For closed or locked users, permission_code will specify the reason the user was closed or locked. See User Permission Codes (Reason Codes) for more information. |
| phone_numbers | array of strings | List of emails and phone numbers for verifying MFA |
| refresh_token | string | User-specific refresh token for oauth (expires after 10 uses) |
Login Object
| Key | Type | Description |
|---|---|---|
| string | Login email | |
| scope | string | Permissions granted to login credentials |
Full Dehydrate Base Document Object
| Key | Type | Description |
|---|---|---|
| address_city | string | City associated with the document owner, this can be home address of a person or business address of a corp |
| address_country_code | string | Country associated with the document owner, this can be home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (i.e. US) |
| address_postal_code | string | Postal code associated with the document owner, this can be home address of a person or business address of a corp |
| address_street | string | Street address associated with the document owner, this can be home address of a person or business address of a corp. Please include apartment suite or unit numbers |
| address_subdivision | string | State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (i.e. CA) for US states |
| alias | string | Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry) |
| day | string | In case of a person this is day of birth. In case of business entity, this is day of organization |
| string | Email associated with the document | |
| entity_scope | string | See Base Documents for more information |
| entity_type | string | See Base Documents for more information |
| id | string | Base document ID |
| ip | string | IP of where the document is being submitted from |
| month | string | In case of a person this is month of birth. In case of business entity, this is month of organization |
| name | string | Name of the document owner |
| permission_scope | string | See Base Documents Intro for more information |
| phone_number | string | Phone number associated with the document |
| physical_docs | array of objects | List of View User w/ Full Dehydrate |
| screening_results | array of objects | List of screening tests and results. If MATCH user may require further investigation |
| social_docs | array of objects | List of View User w/ Full Dehydrate |
| virtual_docs | array of objects | List of View User w/ Full Dehydrate |
Full Dehydrate Sub-Document Object
| Key | Type | Description |
|---|---|---|
| document_type | string | Type of sub-document (EMAIL, PHONE_NUMBER, AOI, etc.) |
| document_value | string | Value of sub-document (may be hashed depending on the type of document) |
| id | string | ID of the sub-document |
| last_updated | string | Date sub-document was last updated (milliseconds since Unix epoch time) |
| meta.matches.address | string | Address match |
| meta.matches.dob | string | Date of birth match |
| meta.matches.identification | string | Identification match |