Skip to content
/User Status

User Status API (1.0)

This API enables customer to get a user status based on the filter and result keys.

Download OpenAPI description
user-status-docs.json
user-status-docs.yaml
Overview
URL
https://sqr.id
SQR
support@sqr.id
Languages
Servers
https://api.sqr-group.com/

User Status

— This API enables customer to get a user status based on the filter and result keys.

Operations

Get User Status

Request

Query user status information with flexible filtering and pagination.

Security
bearer
Bodyapplication/jsonrequired

Request parameters for filtering and retrieving user status data

filtersobject
Example: {"email":"user@example.com","age":{"gte":18,"lte":65},"registration_status":"active","is_deleted":false}
result_keysArray of strings

Array of field names to include in the response. Only these fields will be returned for each user. If not specified, a default dataset is provided.

Example: ["id","email","name","age","registration_status"]
paginationobject
Example: {"limit":20,"offset":0}
curl -i -X POST \
  https://api.sqr-group.com/v1/user-status \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "result_keys": [
      "id",
      "name",
      "first_name",
      "middle_name",
      "last_name",
      "phone",
      "email",
      "dob",
      "age",
      "full_address",
      "address1",
      "address2",
      "city",
      "state",
      "country",
      "postcode",
      "guardian_name",
      "guardian_dob",
      "guardian_age",
      "data_sharing_agreed",
      "override_status",
      "override_notes",
      "is_deleted",
      "selfie_liveness_score",
      "fmc_score",
      "gbg_high_level_result",
      "high_level_result",
      "document_overall_validation",
      "registration_submitted",
      "registration_status",
      "mobile_registration_status",
      "organization_id",
      "organization_name",
      "id3_match_status",
      "id3_pep_sanction_result",
      "connection_status",
      "connection_status_updated_at",
      "created_at",
      "updated_at"
    ],
    "pagination": {
      "limit": 10,
      "offset": 0
    }
  }'

Responses

User status information has been successfully retrieved.

Bodyapplication/json
resultsArray of objects(FilteredResultKey)required

Array of user records containing only the fields specified in the result_keys parameter. Each record is a dynamic object where the available fields depend on the requested result_keys.

Example: [{"id":"157a50ef-cdf9-44f0-9e8f-a3d5d87e66e6","name":"John Doe","first_name":"John","middle_name":"A","last_name":"Doe","phone":"+1-555-1234","email":"john.doe@example.com","dob":"1999-05-15","age":25,"full_address":"123 Main St, Springfield, IL, USA","address1":"123 Main St","address2":"Apt 4B","city":"Springfield","state":"IL","country":"US","postcode":"62701","guardian_name":"Jane Doe","guardian_dob":"1970-08-20","guardian_age":54,"data_sharing_agreed":true,"override_status":"AUTO_APPROVED","override_notes":"Manual verification completed.","is_deleted":false,"selfie_liveness_score":92.21,"fmc_score":85.05,"gbg_high_level_result":"pass","high_level_result":"verified","document_overall_validation":"PASS","registration_submitted":true,"registration_status":"active","mobile_registration_status":"REGISTRATION_COMPLETED","organization_id":"org-1001","organization_name":"Acme Corporation","id3_match_status":"PASS","id3_pep_sanction_result":{"status":"Pending","timestamp":"2025-09-29T10:07:17.623Z","pep_result":{"notes":[],"gender":"Male","qrCode":"123312","status":"Flagged","aliases":[],"version":1737447030528,"datasets":["PEP-CURRENT","REL","RRE","SAN-CURRENT"],"lastName":"Trump","addresses":[{"city":"New York City","line1":"725 Fifth Avenue","line2":"Manhattan","county":"New York","postcode":"10022","addressType":"Residential","countryIsoCode":"US"}],"ddEntries":[],"evidences":[],"firstName":"Donald","isDeleted":false,"griEntries":[],"insEntries":[],"isDeceased":false,"middleName":"John"},"sanction_result":{"notes":[],"gender":"Male","qrCode":"123312","status":"Flagged","aliases":[],"version":1737447030528,"datasets":["PEP-CURRENT","REL","RRE","SAN-CURRENT"],"lastName":"Trump","addresses":[{"city":"New York City","line1":"725 Fifth Avenue","line2":"Manhattan","county":"New York","postcode":"10022","addressType":"Residential","countryIsoCode":"US"}],"ddEntries":[],"evidences":[],"firstName":"Donald","isDeleted":false,"griEntries":[],"insEntries":[],"isDeceased":false,"middleName":"John"}},"connection_status":"CONNECTED","connection_status_updated_at":"2025-09-19T14:00:00Z","created_at":"2025-09-19T12:00:00Z","updated_at":"2025-09-19T14:30:00Z"}]
results[].​idstring

Unique user identifier

Example: "157a50ef-cdf9-44f0-9e8f-a3d5d87e66e6"
results[].​namestring

Full name of the user

Example: "John Doe"
results[].​first_namestring

First name of the user

Example: "John"
results[].​middle_namestring

Middle name of the user

Example: "Michael"
results[].​last_namestring

Last name of the user

Example: "Doe"
results[].​phonestring

Phone number of the user

Example: "+1234567890"
results[].​emailstring

Email address of the user

Example: "user@example.com"
results[].​dobobject

Date of birth of the user

Example: "1990-01-01"
results[].​agenumber

Age of the user

Example: 25
results[].​full_addressstring

Full address of the user

Example: "123 Main St, New York, NY 10001"
results[].​address1string

Primary address line

Example: "123 Main St"
results[].​address2string

Secondary address line

Example: "Apt 4B"
results[].​citystring

City of the user

Example: "New York"
results[].​statestring

State or province of the user

Example: "NY"
results[].​countrystring

Country of the user

Example: "US"
results[].​postcodestring

Postal code of the user

Example: "10001"
results[].​guardian_namestring

Name of the guardian

Example: "Jane Doe"
results[].​guardian_dobobject

Date of birth of the guardian

Example: "1965-05-15"
results[].​guardian_agenumber

Age of the guardian

Example: 58
results[].​data_sharing_agreedboolean

Whether the user has agreed to data sharing

Example: true
results[].​override_statusstring

Override status for the user

Example: "AUTO_APPROVED"
results[].​override_notesstring

Override notes for the user

Example: "Manual verification completed"
results[].​is_deletedboolean

Whether the user record is deleted

Example: false
results[].​selfie_liveness_scorenumber

Selfie validation score

Example: 85.05
results[].​fmc_scorenumber

FMS (Facial Matching Score)

Example: 92.21
results[].​gbg_high_level_resultstring

GBG high level result

Example: "pass"
results[].​high_level_resultstring

High level validation result

Example: "Passed"
results[].​document_overall_validationstring

Document overall validation status

Example: "PASS"
results[].​registration_submittedboolean

Whether registration has been submitted

Example: true
results[].​registration_statusstring

Registration status of the user

Enum"Activated""Rejected""Referred""For Review""Complete""Deleted"
Example: "Activated"
results[].​mobile_registration_statusstring

Mobile registration status

Enum"INCOMPLETE""PHONE_VERIFICATION""EMAIL_VERIFICATION""REQUEST_BASE_ACCOUNT_DATA""REQUEST_ACCOUNT_DATA""REQUEST_ADDRESS""REQUEST_GUARDIANS_INFO""REQUEST_PAYMENT""REQUEST_PROFILE_PICTURE""REQUEST_ID_VERIFICATION"
Example: "REGISTRATION_COMPLETED"
results[].​organization_idstring

Organization ID

Example: "org-123"
results[].​organization_namestring

Organization name

Example: "SQR Group"
results[].​created_atobject

Record creation timestamp

Example: "2023-01-01T00:00:00Z"
results[].​id3_pep_sanction_statusstring

ID3 match status for PEP and Sanction screening

Example: "PASS"
results[].​id3_pep_sanction_resultobject
Example: {"status":"Pending","timestamp":"2025-09-29T10:07:17.623Z","pep_result":{"notes":[],"gender":"Male","qrCode":"123312","status":"Flagged","aliases":[],"version":1737447030528,"datasets":["PEP-CURRENT","REL","RRE","SAN-CURRENT"],"lastName":"Trump","addresses":[{"city":"New York City","line1":"725 Fifth Avenue","line2":"Manhattan","county":"New York","postcode":"10022","addressType":"Residential","countryIsoCode":"US"}],"ddEntries":[],"evidences":[],"firstName":"Donald","isDeleted":false,"griEntries":[],"insEntries":[],"isDeceased":false,"middleName":"John"},"sanction_result":{"notes":[],"gender":"Male","qrCode":"123312","status":"Flagged","aliases":[],"version":1737447030528,"datasets":["PEP-CURRENT","REL","RRE","SAN-CURRENT"],"lastName":"Trump","addresses":[{"city":"New York City","line1":"725 Fifth Avenue","line2":"Manhattan","county":"New York","postcode":"10022","addressType":"Residential","countryIsoCode":"US"}],"ddEntries":[],"evidences":[],"firstName":"Donald","isDeleted":false,"griEntries":[],"insEntries":[],"isDeceased":false,"middleName":"John"}}
results[].​connection_statusstring

User status of connection to organization

Example: "CONNECTED"
results[].​updated_atobject

Record last update timestamp

Example: "2023-01-01T00:00:00Z"
paginationobjectrequired
Example: {"limit":10,"offset":0,"total":150}
pagination.​limitnumber>= 1

Maximum number of records to return

Default 10
Example: 10
pagination.​offsetnumber>= 0

Number of records to skip for pagination

Default 0
Example: 0
Response
application/json
{
  "results": [
    { … }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 150
  }
}
Copyright © 2025 SQR. All Rights Reserved.