Authentication

Introduction

Access Token

Authorize

PAYMENTS API SPECIFICATION

Quotes

Beneficiaries

Deals

Bank Accounts

Models

Users API

Introduction

Users API Specification

Users

Get a list of all users

Reference

Models

get

/users/{userId}

Retrieves the details of a single user based on their UserId.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

The request has succeeded. Response body will contain the details of the user

1 Example

Schema

object

userId

string

1 validation

hasBeneficiary

boolean

True if user has configured a beneficiary.

status

string

The current status of the user.

2 validations

first

string

1 validation

middle

string

1 validation

last

string

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

Path Params

1 path param not set

userId

$$.env

1 variable not set

oauth_access_token