İçeriğe geç
Apex Settlement
Onboarding

Download a Compliance Document

Gereken izincustomer:profile:writeAPI referansındaki uç nokta açıklamaları İngilizcedir.
GET
/v1/documents/{id}/content

The file itself, as an attachment of its type (application/pdf, image/jpeg or image/png). Every read is recorded.

Requires the customer:profile:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Yetkilendirme

ApiKey
headerYetkilendirmeBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Yol parametreleri

id*string

The document's id.

Biçimuuid

Başlık parametreleri

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Biçimuuid

Yanıt gövdesi

OK

response?file
Biçimbinary
Örnek istek
curl -X GET 'http://localhost:3480/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/content'
Örnek yanıt
"string"