patch https://uat-api.synapsefi.com/v3.1/users/
Add another set of base documents to the user
Recommendation
Before submitting this API Call it is recommended to first perform the Verify Address API call.
Request Body
| Key | Type ‌‌  ‌‌  ‌‌ ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌  ‌‌ ‌‌  ‌‌  ‌‌ ‌‌  ‌‌ | Description |
|---|---|---|
| name | string | [Required] Name of the document owner |
| alias | string | Alias of the document owner (this can be the name or in case of businesses it can be the DBA entry) |
| string | [Required] Email associated with the document | |
| phone_number | string | [Required] Phone number associated with the document |
| ip | string | [Required] IP of where the document is being submitted from |
| entity_scope | string | [Required] See Base Documents for more information |
| entity_type | string | [Required] See Base Documents for more information |
| day | integer | [Required] In case of a person this is day of birth. In case of business entity, this is day of organization |
| month | integer | [Required] In case of a person this is month of birth. In case of business entity, this is month of organization |
| year | integer | [Required] In case of a person this is year of birth (must be over 18 unless account is a joint account with parent/legal guardian). In case of business entity, this is year of organization |
| address_street | string | [Required] 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 | [Required] City associated with the document owner, this can be home address of a person or business address of a corp |
| address_subdivision | string | [Required] State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (e.g. CA) |
| address_postal_code | string | [Required] Postal code associated with the document owner, this can be home address of a person or business address of a corp |
| address_country_code | string | [Required] 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) |
| physical_docs[] | array of objects | See Physical Documents for more information |
| social_docs[] | array of objects | See Social Documents for more information |
| virtual_docs[] | array of objects | See Virtual Documents for more information |