User

A user: create one, check one exists, get one, or set its contact email.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

user, err := client.User(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(user)
created, err := client.User(nil).Create(map[string]any{"email": "example", "registrationCode": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.User(nil).Update(map[string]any{"id": 1, "email": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

Construct client as shown in the Lua setup, then call the operations:

local user, err = client:User():load({ id = 1 })
local created, err = client:User():create({ email = "example", registrationCode = "example" })
local updated, err = client:User():update({ id = 1, email = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$user = $client->User()->load(["id" => 1]);
$created = $client->User()->create(["email" => "example", "registrationCode" => "example"]);
$updated = $client->User()->update(["id" => 1, "email" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

user = client.User().load({"id": 1})
created = client.User().create({ "email": "example", "registrationCode": "example" })
updated = client.User().update({"id": 1, "email": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

user = client.User.load({ "id" => 1 })
created = client.User.create({ "email" => "example", "registrationCode" => "example" })
updated = client.User.update({ "id" => 1, "email" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const user = await client.User().load({ id: 1 })
const created = await client.User().create({ email: "example", registrationCode: "example" })
const updated = await client.User().update({ id: 1, email: "example" })

Fields

create

POST /user/signup/registration_code

Operation ID: userCreate.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Request body

application/json

Responses

200: OK - User is created successfully

application/json

Example response:

{
  "active": true,
  "details": null,
  "email": "new.user@domain.com",
  "id": 12345,
  "name": null
}

409: Conflict - User already exists

application/json

Example response:

{
  "errors": [
    {
      "arguments": [
        "email",
        "class com.transferwise.fx.api.ApiRegisterCommand",
        "existing.user@domain.com"
      ],
      "code": "NOT_UNIQUE",
      "message": "You're already a member. Please login",
      "path": "email"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /users/exists

Operation ID: userCheckExists.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Request body

application/json

Responses

200: OK - Successfully checked user existence

application/json

Example response:

{
  "exists": true
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /users/{userId}

Operation ID: userGetById.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Responses

200: OK - Successfully retrieved user

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /users/{userId}/contact-email

Operation ID: userContactEmailGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved contact email address

application/json

Example response:

{
  "email": "new-user@email.com"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /me

Operation ID: userGetByToken.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Responses

200: OK - Successfully retrieved user

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PUT /users/{userId}/contact-email

Operation ID: userContactEmailSet.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: OK - Contact email address set successfully

application/json

Example response:

{
  "email": "new-user@email.com"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.