API Documentation
Offramps API
Offramps API
  • Guides
    • Getting Started
  • API Reference
    • Authentication
    • Agreements
      • Agreements#Show
    • Users
      • Users#Create
      • Users#Show
      • Users#Index
    • KYC Sessions
      • KYC#Create
    • Payment Details
      • PaymentDetails#Create
      • PaymentDetails#Index
      • PaymentDetails#Show
      • PaymentDetails#Validate
      • PaymentDetails#Deactivate
      • Rail Availability
      • Required Fields For Local Currency Payouts
      • Required Fields For Swift Currency Payouts
    • Quotes
      • How to make a payment
      • Quotes#Create
      • Quotes#Show
      • Quotes#Execute
      • Quote#Rate
    • Offramps
      • Offramps#Index
      • Offramps#Create
      • Offramps#Update
      • Offramps#Show
      • Limitations
    • Webhooks
      • KYC Webhook
      • Offramp Webhook
      • Payment Detail Webhook
      • Webhook Signatures
    • Errors
    • Conversions
      • Conversions#Create
  • Sandbox Only
    • Sandbox Special Moves
Powered by GitBook
On this page
  • Fetches all Users associated with your Organization
  • Fetches all users
  1. API Reference
  2. Users

Users#Index

Fetches all Users associated with your Organization

Example Request

curl https://{{base_url}}/users
-X GET \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-type: application/json" \

Endpoint Information

Fetches all users

GET https://{{base_url}}/users

Fetches all users associated with your organization account

{
    "users": [
        {
            "id": "a25a4274-8f50-4579-b476-8f35b297d4ad",
            "beneficiary_type": "individual",
            "first_name": "Marco",
            "last_name": "Pierre White",
            "company_name": null,
            "email": "marco@cheq.xyz",
            "date_of_birth": "12/12/1985",
            "address_line1": "2 Bellevue Road",
            "address_line2": "Wandsworth Common",
            "city": "London",
            "state": "London",
            "postcode": "SW177EG",
            "country": "GB",
            "nationality": "GB",
            "ssn": null,
            "source_of_funds": null,
            "business_activity": null,
            "kyc": {
                "general": {
                    "status": "not_started",
                    "moderation_comment": null
                },
                "eur": {
                    "status": "not_started",
                    "swift_status": "not_started"
                },
                "usd": {
                    "status": "not_started",
                    "swift_status": "not_started"
                },
                "ars": {
                    "status": "not_started",
                    "swift_status": "not_started"
                }
            }
        }
    ]
}
PreviousUsers#ShowNextKYC Sessions