First Leeward

Users

List users

GEThttps://api.firstleeward.com/v0/users

Retrieves a paginated list of users. Use cursor-based pagination by passing the nextCursor value from the response to get subsequent pages. Use externalId to resolve your own identifier back to a First Leeward user. In CORPORATE mode, use companyId to filter users by company. Pass includeTotalCount=true to also get the number of users matching the filters.

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Query Parameters

limitintegerdefault: 20

Maximum number of items to return (1-100, default: 20)

cursorstring

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

idstring<uuid>

Filter users by exact ID match

externalIdstring

Filter users by exact match on your own identifier, as supplied at creation

companyIdstring<uuid>

Filter users by company ID (CORPORATE mode only)

applicationStatusstring[]

Filter users by application status (comma-separated)

Available options:NOT_STARTEDAWAITING_DOCUMENTSIN_REVIEWAPPROVEDREJECTEDRETRY_REQUIRED
includeTotalCountstring

When true, the response includes totalCount, the number of items matching the filters across all pages. Counting adds work to the request, so pass it only on the first page and only when you need it.

Response

200Response for status 200
itemsobject[]required
Show child attributes
idstring<uuid>required

Unique user identifier

externalIdstring | nullrequired

Your own identifier for this user, as supplied at creation. Null if none was provided.

emailstring<email>required

User email address

phoneNumberstringrequired

Phone number in E.164 format

firstNamestring | nullrequired

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

lastNamestring | nullrequired

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

countrystring | nullrequired

ISO 3166-1 alpha-2 country code

dateOfBirthstring | nullrequired

Date of birth (YYYY-MM-DD). Filled from the verified KYC identity, or as sent at creation on corporate employee projects.

nationalitystring | nullrequired

Nationality (ISO 3166-1 alpha-2) as sent at creation on corporate employee projects. Null on other projects.

companyIdstring<uuid> | nullrequired

Company ID (set in CORPORATE program mode)

applicationobjectrequired

KYC application status

Show child attributes
statusstringrequired

Current KYC application status

Available options:NOT_STARTEDAWAITING_DOCUMENTSIN_REVIEWAPPROVEDREJECTEDRETRY_REQUIRED
rejectionReasonstring | nullrequired

Human-readable reason for rejection. Set when status is REJECTED or RETRY_REQUIRED, null otherwise.

rejectionLabelsstring[] | nullrequired

Machine-readable reject codes from the compliance review (for example FORGERY, SELFIE_MISMATCH, EXPIRATION_DATE). Set when status is REJECTED or RETRY_REQUIRED, null otherwise. The set of codes is open-ended - handle unknown values. For your internal use only - do not display these codes to the end user.

documentsobject[] | nullrequired

Supporting documents and their per-document review state. Null for applications with no supporting documents.

Show child attributes
typestringrequired

Supporting document category

Available options:IDENTITYPROOF_OF_ADDRESSCURP
statusstringrequired

Review state of this document

Available options:PENDINGUPLOADEDRETRY_REQUIREDREJECTED
createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

nextCursorstring | nullrequired

Cursor for next page, or null if no more items

totalCountinteger

Number of items matching the filters across all pages, ignoring cursor and limit. Present only when includeTotalCount=true.

400companyId is not allowed in Consumer program mode
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired