Borderless Docs
  • Get Started
    • Welcome to Borderless
    • Quick Start
  • About us
    • About us
      • Supported countries
  • Reference
    • API Reference
      • Authentication
      • Users
      • KYC
      • Rates
      • Orders
      • Webhooks
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Users

PreviousAuthenticationNextKYC

Last updated 1 year ago

Create a User

Find a User

Find all Users

Delete User

Update User

Find a User

get
Authorizations
Responses
200
The found User
application/json
401
Unauthorized
500
Internal server error
get
GET /user HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "externalClientId": "ABC-123"
}

Finds all users

get
Authorizations
Responses
200
List of users
application/json
401
Unauthorized
500
Internal server error
get
GET /merchant/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": 1,
    "externalClientId": "ABC-123"
  }
]

Delete a User

delete
Authorizations
Responses
200
Ok.
401
Unauthorized
500
Internal server error
delete
DELETE /user HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content
  • Create a User
  • POSTCreate a new User
  • Find a User
  • GETFind a User
  • Find all Users
  • GETFinds all users
  • Delete User
  • DELETEDelete a User
  • Update User
  • PATCHUpdate a User

Create a new User

post
Authorizations
Body
firstNamestringRequired

User first name

Example: John
lastNamestringRequired

User last name

Example: Doe
emailstringRequired

User email

Example: johndoe@example.com
addressstringRequired

User address

Example: Harcourt 4567
citystringRequired

User city

Example: Toronto
stateProvincestringRequired

User state/province

Example: Ontario
countryCodestringRequired

User ISO 3166 country code

Example: CAN
postalCodestringRequired

User postal code

Example: M4C
Responses
200
Created user
application/json
401
Unauthorized
500
Internal server error
post
POST /user HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@example.com",
  "address": "Harcourt 4567",
  "city": "Toronto",
  "stateProvince": "Ontario",
  "countryCode": "CAN",
  "postalCode": "M4C"
}
{
  "externalClientId": "ABC-123",
  "id": 1
}

Update a User

patch
Authorizations
Body
firstNamestringOptional

User first name

Example: John
lastNamestringOptional

User last name

Example: Doe
emailstringOptional

User email

Example: johndoe@example.com
addressstringOptional

User address

Example: Harcourt 4567
citystringOptional

User city

Example: Toronto
stateProvincestringOptional

User state/province

Example: Ontario
countryCodestringOptional

User ISO 3166 country code

Example: CAN
postalCodestringOptional

User postal code

Example: M4C
Responses
200
Updated user
application/json
401
Unauthorized
500
Internal server error
patch
PATCH /user HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@example.com",
  "address": "Harcourt 4567",
  "city": "Toronto",
  "stateProvince": "Ontario",
  "countryCode": "CAN",
  "postalCode": "M4C"
}
{
  "id": 1,
  "externalClientId": "ABC-123"
}