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
{
"data": [
{
"id": 5,
"first_name": "AutoTest",
"last_name": "User",
"username": "codecept_user",
"email": "codecept_user@trustswiftly.dev",
"verifications": [
{
"id": 1,
"name": "Email",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 2,
"name": "Phone / SMS",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 3,
"name": "Document / ID",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 4,
"name": "PayPal",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 5,
"name": "Video",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 6,
"name": "Voice",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 7,
"name": "Secure Card",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 8,
"name": "Geolocation",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 9,
"name": "Social Account",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 10,
"name": "Two-Step Authentication",
"status": {
"value": 0,
"friendly": "Pending"
}
}
],
"phone": null,
"avatar": "https://cdn.trustswiftly.com/assets/img/profile.png",
"address": null,
"country_id": null,
"role_id": 2,
"status": "Active",
"birthday": null,
"last_login": "2020-09-07 19:56:35",
"two_factor_country_code": 0,
"two_factor_phone": "",
"two_factor_options": null,
"email_verified_at": null,
"created_at": "2020-09-11 01:33:51",
"updated_at": "2020-09-11 01:33:51"
}
]
}
curl --location --request GET 'https://{sub-domain}.trustswiftly.com/api/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1|GqRQaD0nMBmGkIKLiPuOPLAckxhupWyjVEZKjsj1' \
--header 'User-Agent: TrustSwiftly/1.0'
Get User
GET
https://{sub-domain}.trustswiftly.com/api/users/{id}
Retrieve a specific users profile.
Headers
{
"data": {
"id": 7,
"first_name": "New",
"last_name": "Name",
"username": "Verify_User2101131027492493",
"email": "testing@test.com",
"verifications": [
{
"id": 1,
"name": "Email",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 2,
"name": "Phone / SMS",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 3,
"name": "Document / ID",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 4,
"name": "PayPal",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 5,
"name": "Video",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 6,
"name": "Voice",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 7,
"name": "Secure Card",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 8,
"name": "Geolocation",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 9,
"name": "Social Account",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 10,
"name": "Two-Step Authentication",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 11,
"name": "Bank",
"status": {
"value": 0,
"friendly": "Pending"
}
},
{
"id": 12,
"name": "Live Video",
"status": {
"value": 0,
"friendly": "Pending"
}
}
],
"phone": null,
"avatar": "https://images.trustswiftly.com/public/avatars/none.png",
"address": null,
"country_id": null,
"role_id": 2,
"status": "Active",
"birthday": null,
"last_login": "2021-01-14 03:33:33",
"two_factor_country_code": 0,
"two_factor_phone": "",
"two_factor_options": null,
"email_verified_at": null,
"created_at": "2021-01-13 22:27:49",
"updated_at": "2021-01-14 03:33:33"
}
}
curl --location --request GET 'https://{sub-domain}.trustswiftly.com/api/users/2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1|GqRQaD0nMBmGkIKLiPuOPLAckxhupWyjVEZKjsj1' \
--header 'User-Agent: TrustSwiftly/1.0'
Create User
POST
https://{sub-domain}.trustswiftly.com/api/users
Create a given users profile.
Headers
Request Body
{
"status": "success",
"id": 69,
"user_id": "3639",
"magic_link": "https:\/\/test.trustswiftly.com\\/security-verify?expires=1325603631&key=16RWTtJRKTwjFIQCGWDEZrWkW4Qq2DdvfUQhdadug3AVwWu5mbZht&signature=768898ec51b20a623ba813969215f23785b784f213d04c0046265b3c6"
}
curl --location --request POST 'https://{sub-domain}.trustswiftly.com/api/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1|GqRQaD0nMBmGkIKLiPuOPLAckxhupWyjVEZKjsj1' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
"email": "testing@test.com",
"template_id": "tmpl_MQ"
}'
Update User
PATCH
https://{sub-domain}.trustswiftly.com/api/users/{id}
Update a provided user.
Headers
Request Body
curl --location --request PATCH 'https://{sub-domain}.trustswiftly.com/api/users/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 2|GM2loELoTfc8rXC0PoC4WagW2eEQzE1AxhsqQ8Sn' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
"first_name": "New",
"last_name": "Name",
"template_id": "tmpl_MQ"
}'
Update Verification
PATCH
https://{sub-domain}.trustswiftly.com/api/users/{id}/verifications
Update a status of a verification
Headers
Request Body
curl --location --request PATCH 'https://{sub-domain}.trustswiftly.com/api/users/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 2|GM2loELoTfc8rXC0PoC4WagW2eEQzE1AxhsqQ8Sn' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
"verification_id": "7",
"status": "2"
}
Delete User
DELETE
https://{sub-domain}.trustswiftly.com/api/users/{id}
Delete a provided user.
Headers
{
"success": true
}
curl --location --request DELETE 'https://{sub-domain}.trustswiftly.com/api/users/1' \
--header 'Authorization: Bearer 1|GqRQaD0nMBmGkIKLiPuOPLAckxhupWyjVEZKjsj1' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw ''
Get Magic Link
POST
https://{sub-domain}.trustswiftly.com/api/users/{id}/verify-url
Generate a magic link used for user authentication
Headers
Request Body
{
"short_url": "https://tinyurl.com/y32d35rf",
"full_url": "https://{sub-domain}.trustswiftly.com/security-verify?expires=1610753625&key=7&signature=3949637e17906a42bd3d0254af80a825f2696b9ba948cdf3654f0e354a2f6cef"
}
curl --location --request POST 'https://{sub-domain}.trustswiftly.com/api/users/1/verify-url' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1|GM2loELoTfc8rXC0PoC4WagW2eEQzE1AxhsqQ8Sn' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
"expiration_hours": 24
}'
Last updated