RevKeenDocs
StatusSupport
API Reference
Customer Portal

Retrieve the authenticated customer

Returns the customer represented by the bearer token. Useful as a warm-up / identity check when an embedded portal page loads.

GET/customer-portal/customer

Returns the customer represented by the bearer token. Useful as a warm-up / identity check when an embedded portal page loads.

Related endpoints

  • POST /customer-portal/sessions — Create a customer-portal session
  • GET /customer-portal/subscriptions — List the authenticated customer's subscriptions
  • GET /customer-portal/subscriptions/{id} — Retrieve a subscription
  • POST /customer-portal/subscriptions/{id}/cancel — Cancel a subscription
  • GET /customer-portal/invoices — List the authenticated customer's invoices
  • GET /customer-portal/invoices/{id} — Retrieve an invoice
  • GET /customer-portal/mandates — List the authenticated customer's Direct Debit mandates
  • POST /customer-portal/mandates/{id}/re-authorize — Re-authorise a Direct Debit mandate with new bank details

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X GET "https://api.revkeen.com/v2/customer-portal/customer" \
  -H "Authorization: Bearer $REVKEEN_PORTAL_TOKEN"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11",    "object": "customer",    "email": "ada.lovelace@example.com",    "name": "Ada Lovelace",    "phone": "+44 20 7946 0958",    "company_name": "Analytical Engines Ltd",    "default_currency": "GBP",    "locale": "en-GB",    "created_at": "2026-04-02T10:00:00.000Z"  }}

Put this endpoint to work

Manage customers