Skip to main content
GET
Get a customer

What this endpoint does

Returns the current record for one customer.

When to use it

Use it for customer detail, support checks, and authoritative state after a webhook.

Before you call

Authenticate with customer read access and pass a customer ID owned by the same tenant account.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

The customer’s verificationStatus is in_progress, approved, rejected, or requires_action; each entitlements entry carries its own status from the same set. Both are authoritative at response time — only approved entitlements can be used.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Customers for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Path Parameters

id
string
required

Response

The customer.

id
string
required

Unique Wayex identifier for this customer.

Minimum string length: 1
counterpartyId
string
required

The client account (counterparty) this customer belongs to. For API callers this is always your own account id.

Minimum string length: 1
type
enum<string>
required

Whether the customer is an individual (natural person) or a business (legal entity).

Available options:
individual,
business
contact
object
required
verificationStatus
enum<string>
required

Current verification state. Value can only move on the customer's behalf once approved.

Available options:
in_progress,
approved,
rejected,
requires_action
entitlements
object[]
required

The capabilities this customer is cleared for, granted as verification completes.

createdAt
string<date-time>
required

When the customer was created (ISO 8601).

externalCustomerId
string

Your own identifier for this customer, echoed back for cross-referencing.

Minimum string length: 1
businessDetails
object
individualDetails
object
metadata
object