List users
curl --request GET \
--url https://sg.sandbox.api.reap.global/users/ \
--header 'Authorization: Bearer <token>' \
--header 'Reap-Version: <reap-version>'const options = {
method: 'GET',
headers: {'Reap-Version': '<reap-version>', Authorization: 'Bearer <token>'}
};
fetch('https://sg.sandbox.api.reap.global/users/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/users/"
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "cardholder_8f21a",
"email": "john.doe@example.com",
"phoneNumber": "+14155552671",
"firstName": "John",
"lastName": "Doe",
"country": "US",
"dateOfBirth": "1990-05-15",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application": {
"status": "NOT_STARTED",
"rejectionReason": "<string>",
"documents": [
{
"type": "IDENTITY",
"status": "PENDING"
}
]
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:35:00Z"
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "COMPANY_ID_NOT_ALLOWED",
"message": "<string>",
"detail": {}
}
}Users
List 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 Reap user. In CORPORATE mode, use companyId to filter users by company.
GET
/
users
/
List users
curl --request GET \
--url https://sg.sandbox.api.reap.global/users/ \
--header 'Authorization: Bearer <token>' \
--header 'Reap-Version: <reap-version>'const options = {
method: 'GET',
headers: {'Reap-Version': '<reap-version>', Authorization: 'Bearer <token>'}
};
fetch('https://sg.sandbox.api.reap.global/users/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sg.sandbox.api.reap.global/users/"
headers = {
"Reap-Version": "<reap-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "cardholder_8f21a",
"email": "john.doe@example.com",
"phoneNumber": "+14155552671",
"firstName": "John",
"lastName": "Doe",
"country": "US",
"dateOfBirth": "1990-05-15",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"application": {
"status": "NOT_STARTED",
"rejectionReason": "<string>",
"documents": [
{
"type": "IDENTITY",
"status": "PENDING"
}
]
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:35:00Z"
}
],
"nextCursor": "<string>"
}{
"error": {
"code": "COMPANY_ID_NOT_ALLOWED",
"message": "<string>",
"detail": {}
}
}Authorizations
API key as Bearer token
Headers
API version (YYYY-MM-DD)
Available options:
2025-02-14 Example:
"2025-02-14"
Query Parameters
Maximum number of items to return (1-100, default: 20)
Required range:
x <= 100Examples:
20
50
100
Opaque cursor for pagination. Pass nextCursor from previous response to get next page.
Filter users by exact ID match
Filter users by exact match on your own identifier, as supplied at creation
Required string length:
1 - 255Example:
"cardholder_8f21a"
Filter users by company ID (CORPORATE mode only)
Filter users by application status (comma-separated)
NOT_STARTED: KYC verification not yet initiatedAWAITING_DOCUMENTS: Identity data submitted; supporting documents pending upload (Universal KYC only)IN_REVIEW: KYC application submitted and under reviewAPPROVED: KYC verified successfullyREJECTED: KYC rejected (final)RETRY_REQUIRED: KYC requires resubmission
Available options:
NOT_STARTED, AWAITING_DOCUMENTS, IN_REVIEW, APPROVED, REJECTED, RETRY_REQUIRED