Shareholder Documents
List all documents for a shareholder (metadata only)
Changed onList all documents for a shareholder (metadata only)
get/api/v1/merchants/{merchantId}/shareholders/{shareholderId}/documents
Request
- Base URLhttps://core.quidkey.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
merchantIdstring uuid required
The unique identifier of the merchant
Example:123e4567-e89b-12d3-a456-426614174000
shareholderIdstring uuid required
The unique identifier of the shareholder
Example:123e4567-e89b-12d3-a456-426614174001
Response
Success
Example response
{
"success": true,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"documentType": "PROOF_OF_ADDRESS",
"fileName": "proof_of_address.pdf",
"uploadedAt": "2024-01-15T10:30:00.000Z"
}
]
}Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking