patch https://uat-api.synapsefi.com/v3.1/users/#
Request Body
| Key | Type | Description |
|---|---|---|
| documents[] | array of objects | [Required] List of base documents with IDs and fields you wish to update |
Base Document Object
| Key | Type | Description |
|---|---|---|
| id | string | [Required] Base document ID |
| string | Email associated with the document | |
| phone_number | string | Phone number associated with the document |
| name | string | Name of the document owner |
| entity_scope | string | Industry in which the document owner operates. In case of an individual it can be their field of profession, in case of a corp this can be their line of business |
| entity_type | string | Entity type of the document owner, this can be gender in case of an individual or DBA in case of a business |
| 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_city | string | City associated with the document owner, this can be home address of a person or business address of a corp |
| address_subdivision | string | State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (e.g. CA) |
| 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_code_country | 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 (e.g. US) |
Recommendation
If updating Base Doc address with this call, it is recommended to first perform the Verify Address API call to confirm that the provided address is valid.