External Accounts
Users
Events
Real-Time Payments
- GETList Request for Payment Registrations
- GETList Real-Time Payments Request for Payments
- POSTCreate a Real-Time Payments Request for Payment
- GETRetrieve a Real-time Payments Request for Payment
- POSTCancel a Real-time Payments Request for Payment
- POSTComplete a Sandbox Real-time Payments Request for Payment
- GETRetrieve Routing Number Info
Users
Create a User
POST
/
users
curl --request POST \
--url https://api.useswift.dev/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"address": {
"line1": "123 Main St",
"line2": null,
"city": "Anytown",
"state": "CA",
"zip": "12345"
},
"date_of_birth": {
"date": 27,
"month": 7,
"year": 1996
},
"email": "bob.smith@example.com",
"first_name": "Bob",
"last_name": "Smith",
"phone": "1234567890",
"ssn": "123456789"
}'
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Parameters for creating a User.
Response
200
application/json
User
Users represent end users capable of completing transfers via Swift's API.
curl --request POST \
--url https://api.useswift.dev/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"address": {
"line1": "123 Main St",
"line2": null,
"city": "Anytown",
"state": "CA",
"zip": "12345"
},
"date_of_birth": {
"date": 27,
"month": 7,
"year": 1996
},
"email": "bob.smith@example.com",
"first_name": "Bob",
"last_name": "Smith",
"phone": "1234567890",
"ssn": "123456789"
}'
{
"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"
}