Access Legal Entity Verifications
Sometimes merchants will need assistance identifying issues with their verifications and guidance on documents to provide if additional documentation is required. This cookbook will help your support team access Verifications in order to resolve these requests.
Custom Method
1. Search Accounts
The search functionality described in this section can be used here, so long as search results provide a UI path to view the WePay Account details.2. View Verifications
Include Legal Entity Verifications in your merchant details display:
An example custom display for your employees to view a merchant's verifications.
GET /legal_entities/{id}/verifications
API endpoint:Parameter to display | Value to display |
---|---|
additional_representatives.representative_X.personal_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the personal verification for this additional representative is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify this additional representative. Refer support agents to this resource to help guide merchants in document selection. |
controller.personal_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded, and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the personal verification for the controller is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify the controller. Refer support agents to this resource to help guide merchants in document selection |
entity_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded, and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the entity verification is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify the entity. Refer support agents to [this] resource to help guide merchants in document selection. |
Note
For any documents uploaded for verification, track and display the following:
- Date of document upload (collected by you during document upload).
- Type of document (collected by you during document upload).
- Any reject reasons (reflected in the above API response).
- Track time of receipt for Notifications to the
legal_entities.verifications.updated
event topic, specifically when we require verification documents.
current_issues
and upcoming_issues
JSON objects:An example custom display for your employees to view a merchant's verification details.
Partner Center Method
A. Search Accounts
The search functionality described in this section can be used here.B. View Verifications
Include Legal Entity Verifications in your merchant details display. Verifications should include the controller, all additional representatives, and the entity.
Where to view a merchant's verifications in WePay's Partner Center.
To populate Verifications details, fetch the following via the API:
Parameter to display | Value to display |
---|---|
additional_representatives.representative_X.personal_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded, and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the personal verification for this additional representative is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify this additional representative. Refer support agents to this resource to help guide merchants in document selection. |
controller.personal_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded, and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the personal verification for the controller is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify the controller. Refer support agents to this resource to help guide merchants in document selection |
entity_verification | |
verified | Boolean value; if false , display the items below. |
documents | Display any documents which have already been uploaded, and their status. |
current_issues | An array of JSON objects identifying the issue type and target of each unique issue.
|
current_issues.in_review | Identifies whether the entity verification is currently under review. If so, then we are working to resolve the issue. |
current_issues.errant_fields | An array of JSON objects representing unique issues which need to be resolved. |
current_issues.additional_documents_required | Identifies whether we require additional supporting documentation to verify the entity. Refer support agents to this resource to help guide merchants in document selection. |
Note
For any documents uploaded for verification, track and display the following:
- Date of document upload (collected by you during document upload).
- Type of document (collected by you during document upload).
- Any reject reasons (reflected in the above API response).
- Track time of receipt for Notifications to the
legal_entities.verifications.updated
event topic, specifically when we require verification documents.
current_issues
and upcoming_issues
JSON objects:Where to view a merchant's verification details in WePay's Partner Center