patch https://uat-api.synapsefi.com/v3.1/users/#####
Request Body
Sandbox 2FA
Two-factor authentication pins will not be sent out in sandbox
| Key | Type | Description |
|---|---|---|
| documents[ ‌] | array of objects | [Required] List of base documents objects with the social_docs and 2FA devices you wish to add to the user |
Base Document Object
| Key | Type | Description |
|---|---|---|
| id | string | [Required] Base document ID |
| social_docs[ ‌‌] | array of objects | [Required] List of social document objects you wish to add to the user |
Social Document Object
| Key | Type | Description |
|---|---|---|
| document_type | string | [Required] Set as PHONE_NUMBER_2FA or EMAIL_2FA |
| document_value | string | [Required] Email or Phone Number to send MFA pin |
Additional Information
- When a new device is registered to the user, an MFA pin will be sent to the email or phone number provided. To verify the device, the correct pin must be submitted to the API as the
mfa_answer. See Verify 2FA Device for more information