Skip to main content
GET
Get user

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Path Parameters

id
string<uuid>
required

Response

User resource with directly-attached spend policies

id
string<uuid>
required

Unique user identifier

email
string<email>
required

User email address

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"john.doe@example.com"

phoneNumber
string
required

Phone number in E.164 format

Example:

"+14155552671"

firstName
string | null
required

User first name. Null until provided by the client or backfilled from the verified KYC identity on approval.

Example:

"John"

lastName
string | null
required

User last name. Null until provided by the client or backfilled from the verified KYC identity on approval.

Example:

"Doe"

country
string | null
required

ISO 3166-1 alpha-2 country code

Required string length: 2
Example:

"US"

dateOfBirth
string | null
required

Date of birth in YYYY-MM-DD format (populated from KYC)

Example:

"1990-05-15"

companyId
string<uuid> | null
required

Company ID (set in CORPORATE program mode)

application
object
required

KYC application status

createdAt
string
required

ISO 8601 timestamp of creation

Example:

"2024-01-15T10:30:00Z"

updatedAt
string
required

ISO 8601 timestamp of last update

Example:

"2024-01-15T10:35:00Z"

policies
(MerchantRestriction · object | ChannelRestriction · object | TransactionAmountLimit · object | SpendLimit · object | AuthorizationCountLimit · object)[]
required

Active spend policies attached directly to this user. Only directly-attached policies are included - those attached at other scopes and platform-enforced limits are not.

Policy resource