POST
/
users
/
{user_id}
/
archive
Archive a User
curl --request POST \
  --url https://api.useswift.dev/users/{user_id}/archive \
  --header 'Authorization: Bearer <token>'
{
  "address": {
    "line1": "123 Main St",
    "line2": null,
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  },
  "created_at": "2024-01-31T23:59:59Z",
  "date_of_birth": {
    "date": 27,
    "month": 7,
    "year": 1996
  },
  "email": "bob.smith@example.com",
  "phone": "1234567890",
  "first_name": "Bob",
  "id": "user_vjb43lkAdf934jb13Df93",
  "last_name": "Smith",
  "ssn": "123456789",
  "status": "active"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
user_id
string
required

The identifier of the User to archive.

Response

User

Users represent end users capable of completing transfers via Swift's API.

​
address
object
required

The address of the User.

Example:
{
  "line1": "123 Main St",
  "line2": null,
  "city": "Anytown",
  "state": "CA",
  "zip": "12345"
}
​
created_at
string<date-time>
required

The ISO 8601 time at which the User was created.

​
email
string
required

The verified email associated with the User.

​
first_name
string
required

The first name of the User.

​
id
string
required

The User's unique identifier.

​
last_name
string
required

The last name of the User.

​
phone
string | null
required

The verified phone number associated with the User.

​
ssn
string | null
required

The Social Security Number of the User. This field is not required for certain accounts.

​
status
enum<string>
required

The current status of the User.

Available options:
active,
archived
​
date_of_birth
object | null

The date of birth of the User.

Example:
{ "date": 27, "month": 7, "year": 1996 }