Users
The API Key can be generated within your account settings.
Get Users
GET
https://{sub-domain}.trustswiftly.com/api/users
List all the users currently assigned a profile.
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to.
Get User
GET
https://{sub-domain}.trustswiftly.com/api/users/{id}
Retrieve a specific users profile.
Headers
Authorization
string
API Key
is used for server-to-server communication to fetch sensitive data that you already have access to.
Create User
POST
https://{sub-domain}.trustswiftly.com/api/users
Create a given users profile.
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to.
Request Body
notice
string
Display a notice on the dashboard for users such as custom instructions.
string
Customer's email address.
send_link
boolean
Send a verify link to the user via email.
template_id
string
ID of the verification template you wish to assign to this user.
reference_id
string
An ID you can pass that correlates to your own system's user ID.
phone
string
last_name
string
Users last name.
first_name
string
Users first name.
username
string
A unique username for the given user.
send_sms
boolean
Send a verify link to the user via SMS.
custom_verify_data
json string
A json string listing any data validation requirements for a user during document verification. i.e. "custom_verify_data": {"last_name": "Smith"}
order_id
string
If the user is associated with a specific order or transaction.
completion_url
string
Optional custom URL unique per user to redirect to when verifications are completed. Otherwise in General Settings a URL can be set as default.
deaNumber
string
Optional DEA Number for validating a registration with the government data source.
Update User
PATCH
https://{sub-domain}.trustswiftly.com/api/users/{id}
Update a provided user.
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to.
Request Body
username
string
A unique username for the given user.
first_name
string
Users first name
last_name
string
Users last name
phone
string
Phone including international code.
reference_id
string
An ID you can pass that correlates to your own systems user ID.
template_id
string
ID of the verification template you wish to assign to this user.
string
Customers email address.
custom_verify_data
String
A json string listing any data validation requirements for a user during document verification.
order_id
string
If the user is associated with a specific order or transaction.
Update Verification
PATCH
https://{sub-domain}.trustswiftly.com/api/users/{id}/verifications
Update a status of a verification
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to.
Request Body
verification_id
string
The ID corresponding to the verification name
status
string
The status to update the verification
Delete User
DELETE
https://{sub-domain}.trustswiftly.com/api/users/{id}
Delete a provided user.
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to
Get Verify Link
POST
https://{sub-domain}.trustswiftly.com/api/users/{id}/verify-url
Generate a verify link used for user authentication
Headers
Authorization
string
is used for server-to-server communication to fetch sensitive data that you already have access to.
Request Body
expiration_hours
integer
Hour(s) in which the magic link will remain alive before expiring.
Last updated