get https://sandbox.onebrick.io/v1/account/pii
This API returns all previously connected account data of your users by providing PII (Email and/or Phone Number)
Request Parameters
| Key Parameters | Data type | Description |
|---|---|---|
| public_access_token | String | Public-access-token generated using your clientId and clientSecret |
| String | Email of the users | |
| phone_number | String | Phone number of the users |
| consent_id | String | [Mandatory] Partner generated consent identifier that is unique per user |
| consent_method | String | [Mandatory] The consent method used to gather consent from user Type of consent: Physical Form - Signature Web Application - Button Click SMS - SMS Reply Mobile Application - Button Click Email - Email Reply Voice Call - Voice Reply Video Call - Video Reply For example: if the consent is collected by Button Click in your Mobile Application, then please input "Mobile Application - Button Click" as the consent_method |
Response Parameters
| Key Parameters | Data type | Description |
|---|---|---|
| institution_id | Integer | The identification of user's account institution |
| institution_name | String | The name of user's account institution |
| institution_type | String | The type of user's account institution |
| username | String | The username of user's account |
| user_access_token | String | The user access token of user's account. (If null, then the account is not verified) |
| status | String | The verification status of user's account - "verified", means that the user access token can directly be used - "unverified", means that a re-authentication is needed to get the user_access_token |