Get verification information

API Reference
Solutions
Features
Resources
- SDKs and Libraries
- Payments 101

Nothing Found

Get verification information

get/legal_entities/{id}/verifications

The GET /legal_entities/{id}/verifications call allows your platform to retrieve the information WePay requires to verify the identity of a legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.

SecurityappIdAuth and appTokenAuth

Request

path Parameters

required

string [ 1 .. 255 ] characters

ID of the legal entity, generated by WePay when the legal entity is created.

query Parameters

is_expanded	boolean Default: true
is_synchronous	boolean Default: false Delay returning until the legal entity has been assessed for risk. Note: The default is false.

header Parameters

Api-Version required	string Example: 3.0
Unique-Key	string

Responses

200

Response Schema: application/json

resource

required

string

Helps organize information by identifying the resource type of the object data.

Value:	Description
verifications

required

string or null

ID of the legal entity, generated by WePay when the legal entity is created.

path

required

string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required

object

Details the owner resource and owner path.

required

object

Personal details of the controller. Note: A controller is an individual with significant responsibility to control or manage a legal entity. Examples of controllers include, but are not limited to, a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer, or any other individual who regularly performs similar functions as part of a control prong.

required

object or null

Personal information for additional beneficial owners of the legal entity.

required

object

Personal information for additional beneficial owners of the legal entity. Note: You can pass {} to signify that this legal entity does not have any additional representatives.

api_version

required

string

400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples

Response samples

application/json

{"additional_representatives": {"representative_0": {"reference_id": "reference_id_0",
"personal_verification": {"current_issues": [{"additional_documents_required": ["additional_representatives.representative_0.personal_verification.documents"
],
"issue_type": "additional_documents_required",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"identity_verification": {"path": "additional_representatives.representative_0.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"risk_outreach": {"path": "additional_representatives.representative_0.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "risk_outreach",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"documents": [{"create_time": 1480700611,
"id": "31b16e40-6af7-4c8a-9a9f-ad413ba7293f",
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": null,
"reject_reason": {"details": [{"detail_code": "illegible",
"detail_message": "image is illegible"
}
],
"reason_code": "failed_risk_review",
"reason_message": "failed review"
},
"resource": "documents",
"status": "rejected",
"type": "social_security_card"
}
],
"verified": false
}
},
"representative_1": {"reference_id": "reference_id_1",
"personal_verification": {"current_issues": [ ],
"documents": [ ],
"verified": true
}
},
"representative_2": {"reference_id": "reference_id_2",
"personal_verification": {"current_issues": [{"additional_documents_required": ["additional_representatives.representative_2.personal_verification.documents"
],
"issue_type": "additional_documents_required",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"documents": [ ],
"verified": false
}
},
"representative_3": {"reference_id": "reference_id_3",
"personal_verification": {"current_issues": [{"target": {"id": "null",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
},
"issue_type": "errant_fields",
"errant_fields": {"entity_name": ["includes_dba"
],
"primary_url": ["invalid_url"
],
"address": ["does_not_match_provided_doc",
"does_not_match_government_sources"
]
}
}
],
"documents": [ ],
"verified": false
}
}
},
"controller": {"reference_id": "reference_id_4",
"personal_verification": {"current_issues": [{"in_review": ["controller.personal_verification"
],
"issue_type": "in_review",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"identity_verification": {"path": "controller.personal_verification.documents",
"requested_documents": ["drivers_license",
"current_lease_contract"
],
"message": "we need to verify your address"
},
"issue_type": "identity_verification",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
},
{"risk_outreach": {"path": "controller.personal_verification.documents",
"requested_documents": ["current_bank_statement"
],
"message": "we need to verify your date of birth"
},
"issue_type": "risk_outreach",
"target": {"id": null,
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications"
}
}
],
"documents": [{"create_time": 1480700611,
"id": "724ec0d3-2eb5-461e-b72d-a15c6b1a9970",
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": null,
"reject_reason": null,
"resource": "documents",
"status": "in_review",
"type": "social_security_card"
},
{"create_time": 1480700611,
"id": "3838d4ba-f497-4b6f-8d22-19b90cec4f23",
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": null,
"reject_reason": null,
"resource": "documents",
"status": "verified",
"type": "drivers_license"
},
{"create_time": 1480700611,
"id": "242f9ec7-a309-412c-976d-cc84074a508a",
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": null,
"reject_reason": null,
"resource": "documents",
"status": "in_review",
"type": "passport"
}
],
"verified": false
}
},
"entity_verification": {"current_issues": [ ],
"documents": [{"create_time": 1480700611,
"id": "99e0d61d-0b47-41df-9c33-b7bf456d07a8",
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": null,
"reject_reason": null,
"resource": "documents",
"status": "verified",
"type": "evidence_of_corporate_registration"
}
],
"verified": true
},
"id": null,
"owner": {"id": "672b72f5-5136-4304-b553-ec7c8544b51e",
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e",
"resource": "legal_entities"
},
"path": "/legal_entities/672b72f5-5136-4304-b553-ec7c8544b51e/verifications",
"resource": "verifications",
"api_version": "3.0"
}