Account Holders
Access rights
Following access rights need to be enabled for API usage in the MyPuro Portal to use these endpoints:
Read Account Holders
to list and get account holder details
See Access management for more details about enabling access to MyPuro resources.
List Account Holders
Firstly, to check that your API Keys work as expected, make a request to the GET /account-holders endpoint. You should be able to see your own Account Holder information returned in the response. If other Puro.earth Account Holders have granted API access for their resources to you, you would also see their information listed in the response. See the Access sharing section for more details about sharing access to other Account Holders.
List account holders
curl -X 'GET' "/account-holders" \
-H "Accept: application/json" \
-H "Authorization: Basic $BASIC"
object (PaginationData) | |
Array of objects (AccountHolder) <= 100 items |
{- "pagination": {
- "total": 1,
- "offset": 0,
- "limit": 100
}, - "data": [
- {
- "accountHolderId": "f4826423-21b9-4ee0-905d-311e758ee750",
- "name": "Acme Inc.",
- "businessId": "FI12345671",
- "address": {
- "postalCode": "00100",
- "city": "Helsinki",
- "country": "FI",
- "street1": "Long Street",
- "street2": "Long Street 2"
}, - "registeredOn": "2024-12-13T09:53:26.760Z"
}
]
}