Users

The API Key can be generated within your developer settings.

Get Users

GET https://{sub-domain}.trustswiftly.com/api/users

List all the users currently assigned a profile.

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

{
    "data": [
        {
            "id": 5,
            "first_name": "AutoTest",
            "last_name": "User",
            "username": "codecept_user",
            "email": "[email protected]",
            "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 {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0'

Get User

GET https://{sub-domain}.trustswiftly.com/api/users/{id}

Retrieve a specific users profile.

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

{
    "data": {
        "id": 7,
        "first_name": "New",
        "last_name": "Name",
        "username": "Verify_User2101131027492493",
        "email": "[email protected]",
        "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 {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0'

Create User

POST https://{sub-domain}.trustswiftly.com/api/users

Create a given users profile.

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

Request Body

Name

Type

Description

notice

string

Display a notice on the dashboard for users such as custom instructions.

string

Required. 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

Phone including international code. Example +13129450121. It must be in E164 format.

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.

{
  "status": "success",
  "id": 69,
  "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 {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
  "email": "[email protected]",
  "template_id": "tmpl_MQ"
}'

Update User

PATCH https://{sub-domain}.trustswiftly.com/api/users/{id}

Update a provided user.

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

Request Body

Name

Type

Description

string

Customers email address.

username

string

A unique username for the given user.

first_name

string

Users first name

last_name

string

Users last name

status

string

The user's status. Accepted values: Unconfirmed, Active, Verified, Banned, Review.

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.

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.

curl --location --request PATCH 'https://{sub-domain}.trustswiftly.com/api/users/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_key}' \
--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

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

Request Body

Name

Type

Description

verification_id

string

The ID corresponding to the verification name.

status

string

The status to update the verification

current_workflow_id

string

Optional unless verification_id = 3

curl --location --request PATCH 'https://{sub-domain}.trustswiftly.com/api/users/1/verifications' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
  "verification_id": "7",
	"status": "2"
}

Fetch verification mappings

GET /api/settings/verifications

The response includes stable key values and numeric id values for verification methods and statuses. API requests accept either form.

Common method keys:

Key

Name

document_id

Document / ID

secure_card

Secure Card

geolocation

Geolocation

biometric_id

Biometric ID

liveness

Liveness

knowledge

Knowledge

Common status keys:

Key

assigned

processing

complete

rejected

complete_in_review

reset

removed

Update a verification status

PATCH /api/users/{user_id}/verifications

{
  "verification_id": "geolocation",
  "status": "complete"
}

The legacy numeric form still works:

{
  "verification_id": 8,
  "status": 2
}

Mark a document workflow complete

For Document / ID, include current_workflow_id. Fetch workflow IDs from:

GET /api/settings/workflow

That endpoint returns:

id: legacy public ID, accepted by the update API.
encoded_id: stable encoded ID, accepted by the update API.
raw_id: internal workflow ID.

PATCH /api/users/{user_id}/verifications

{
  "verification_id": "document_id",
  "status": "complete",
  "current_workflow_id": "flow_MQ",
  "remarks": "Approved after manual review"
}

The API marks the selected user workflow complete. The overall document_id verification is marked complete once all of the user's assigned document workflows are complete or complete in review.

Remove an assigned verification method

DELETE /api/users/{user_id}/verifications/{verification_key_or_id}

Example:

DELETE /api/users/123/verifications/secure_card

This removes a method only while it is still assigned. Completed or rejected methods return verification_not_removable so historical verification evidence is not deleted accidentally. For Document / ID, assigned document workflows are also removed when the method is removed.

Delete User

DELETE https://{sub-domain}.trustswiftly.com/api/users/{id}

Delete a provided user.

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to

{
    "success": true
}

curl --location --request DELETE 'https://{sub-domain}.trustswiftly.com/api/users/1' \
--header 'Authorization: Bearer {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw ''

Get Verify Link

POST https://{sub-domain}.trustswiftly.com/api/users/{id}/verify-url

Generate a verify link used for user authentication

Headers

Name

Type

Description

Authorization

string

API Key

is used for server-to-server communication to fetch sensitive data that you already have access to.

Request Body

Name

Type

Description

expiration_hours

integer

Hour(s) in which the magic link will remain alive before expiring.

{
    "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 {api_key}' \
--header 'User-Agent: TrustSwiftly/1.0' \
--data-raw '{
  "expiration_hours": 24
}'

PreviousAuthentication NextReverify User

Last updated 6 days ago

hashtagGet Users

hashtagHeaders

hashtagGet User

hashtagHeaders

hashtagCreate User

hashtagHeaders

hashtagRequest Body

hashtagUpdate User

hashtagHeaders

hashtagRequest Body

hashtagUpdate Verification

hashtagHeaders

hashtagRequest Body

hashtagFetch verification mappings

hashtagUpdate a verification status

hashtagMark a document workflow complete

hashtagRemove an assigned verification method

hashtagDelete User

hashtagHeaders

hashtagGet Verify Link

hashtagHeaders

hashtagRequest Body

Get Users

Headers

Get User

Headers

Create User

Headers

Request Body

Update User

Headers

Request Body

Update Verification

Headers

Request Body

Fetch verification mappings

Update a verification status

Mark a document workflow complete

Remove an assigned verification method

Delete User

Headers

Get Verify Link

Headers

Request Body