# Get User Status

Query user status information with flexible filtering and pagination.

Endpoint: POST /v1/user-status
Version: 1.0
Security: bearer

## Request fields (application/json):

  - `filters` (object)
    Optional filters to apply to the query. Supports exact matches for strings and range comparisons for numbers.
    Example: {"email":"user@example.com","age":{"gte":18,"lte":65},"registration_status":"active","is_deleted":false}

  - `filters.id` (string)
    Filter by user ID (exact match)
    Example: "9A6IV5F100014862"

  - `filters.email` (string)
    Filter by email address (exact match)
    Example: "user@example.com"

  - `filters.name` (string)
    Filter by user name (exact match)
    Example: "John Doe"

  - `filters.first_name` (string)
    Filter by first name (exact match)
    Example: "John"

  - `filters.last_name` (string)
    Filter by last name (exact match)
    Example: "Doe"

  - `filters.phone` (string)
    Filter by phone number (exact match)
    Example: "+1234567890"

  - `filters.registration_status` (string)
    Filter by registration status (exact match)
    Enum: "active", "pending", "inactive", "suspended"

  - `filters.mobile_registration_status` (string)
    Filter by mobile registration status (exact match)
    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", "REQUEST_DATA_SHARING_AGREEMENT", "REQUEST_PASSWORD", "REGISTRATION_COMPLETED", "PENDING_ID_VERIFICATION", "SELFIE_VERIFICATION", "ID_READ_FAILED", "FACE_READ_FAILED", "VERIFICATION_PASSED", "VERIFICATION_FAILED ", "FACEMATCH_FAILED", "BIRTHDAY_MATCH_FAILED", "ADDRESS_MATCH_FAILED", "NAME_MATCH_FAILED", "REJECTED_ACCESS", "REQUEST_SUBMIT_REGISTRATION", "ADMIN_REVIEW", "DELETED", "REFERRED_APPLICATION"

  - `filters.organization_name` (string)
    Filter by organization name (exact match)
    Example: "SQR Group"

  - `filters.city` (string)
    Filter by city (exact match)
    Example: "New York"

  - `filters.state` (string)
    Filter by state (exact match)
    Example: "NY"

  - `filters.country` (string)
    Filter by country (exact match)
    Example: "US"

  - `filters.data_sharing_agreed` (boolean)
    Filter by data sharing agreement status
    Example: true

  - `filters.is_deleted` (boolean)
    Filter by deletion status

  - `filters.dob` (object)
    Filter by date of birth
    Example: {"gte":"2000-01-01","lte":"2005-12-31"}

  - `filters.dob.gt` (string)
    Greater than (ISO date)
    Example: "2025-01-01T00:00:00.000Z"

  - `filters.dob.gte` (string)
    Greater than or equal (ISO date)
    Example: "2000-01-01"

  - `filters.dob.lt` (string)
    Less than (ISO date)
    Example: "2025-12-31T23:59:59.999Z"

  - `filters.dob.lte` (string)
    Less than or equal (ISO date)
    Example: "2005-12-31"

  - `filters.dob.eq` (string)
    Equal to (ISO date)
    Example: "2025-06-30T12:00:00.000Z"

  - `filters.age` (object)
    Filter by age range
    Example: {"gte":18,"lte":65}

  - `filters.age.gt` (object)
    Greater than
    Example: 18

  - `filters.age.gte` (object)
    Greater than or equal
    Example: 18

  - `filters.age.lt` (object)
    Less than
    Example: 65

  - `filters.age.lte` (object)
    Less than or equal
    Example: 65

  - `filters.age.eq` (object)
    Equal to
    Example: 25

  - `filters.selfie_liveness_score` (object)
    Filter by selfie score range
    Example: {"gte":0.8}

  - `filters.fmc_score` (object)
    Filter by FMS score range
    Example: {"gte":0.7}

  - `filters.middle_name` (string)
    Filter by middle name (exact match)
    Example: "Michael"

  - `filters.full_address` (string)
    Filter by full address (exact match)
    Example: "123 Main St"

  - `filters.address1` (string)
    Filter by address line 1 (exact match)
    Example: "123 Main St"

  - `filters.address2` (string)
    Filter by address line 2 (exact match)
    Example: "Apt 4B"

  - `filters.postcode` (string)
    Filter by postal code (exact match)
    Example: "10001"

  - `filters.guardian_dob` (object)
    Filter guardian date of birth
    Example: {"gte":"2000-01-01","lte":"2005-12-31"}

  - `filters.guardian_name` (string)
    Filter by guardian name (exact match)
    Example: "Jane Doe"

  - `filters.guardian_age` (object)
    Filter guardian age
    Example: {"gte":30,"lte":60}

  - `filters.override_status` (string)
    Filter by override status (exact match)
    Example: "AUTO_APPROVED"

  - `filters.override_notes` (string)
    Filter by override notes (exact match)
    Example: "This user was manually approved."

  - `filters.gbg_high_level_result` (string)
    Filter by GBG high level result (exact match)
    Example: "Passed"

  - `filters.high_level_result` (string)
    Filter by high level result (exact match)
    Example: "Passed"

  - `filters.document_overall_validation` (string)
    Filter by document overall validation (exact match)
    Example: "PASS"

  - `filters.registration_submitted` (boolean)
    Filter by registration submitted status
    Example: true

  - `filters.organization_id` (string)
    Filter by organization ID (exact match)
    Example: "org-123"

  - `filters.id3_match_status` (string)
    Filter by ID3 match status (exact match)
    Example: "PASSED"

  - `filters.connection_status` (string)
    User connection status
    Example: "CONNECTED"

  - `filters.connection_status_updated_at` (object)
    User connection status
    Example: {"gte":"2025-01-01T00:00:00.000Z","lte":"2025-12-31T23:59:59.999Z"}

  - `filters.created_at` (object)
    Filter by creation date range
    Example: {"gte":"2025-01-01T00:00:00.000Z","lte":"2025-12-31T23:59:59.999Z"}

  - `filters.updated_at` (object)
    Filter by last updated date range
    Example: {"gte":"2025-01-01T00:00:00.000Z","lte":"2025-12-31T23:59:59.999Z"}

  - `result_keys` (array)
    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"]

  - `pagination` (object)
    Pagination parameters to control the number of results returned
    Example: {"limit":20,"offset":0}

  - `pagination.limit` (number)
    Maximum number of records to return
    Example: 20

  - `pagination.offset` (number)
    Number of records to skip for pagination

## Response 200 fields (application/json):

  - `results` (array, 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.id` (string)
    Unique user identifier
    Example: "157a50ef-cdf9-44f0-9e8f-a3d5d87e66e6"

  - `results.name` (string)
    Full name of the user
    Example: "John Doe"

  - `results.first_name` (string)
    First name of the user
    Example: "John"

  - `results.middle_name` (string)
    Middle name of the user
    Example: "Michael"

  - `results.last_name` (string)
    Last name of the user
    Example: "Doe"

  - `results.phone` (string)
    Phone number of the user
    Example: "+1234567890"

  - `results.email` (string)
    Email address of the user
    Example: "user@example.com"

  - `results.dob` (object)
    Date of birth of the user
    Example: "1990-01-01"

  - `results.age` (number)
    Age of the user
    Example: 25

  - `results.full_address` (string)
    Full address of the user
    Example: "123 Main St, New York, NY 10001"

  - `results.address1` (string)
    Primary address line
    Example: "123 Main St"

  - `results.address2` (string)
    Secondary address line
    Example: "Apt 4B"

  - `results.city` (string)
    City of the user
    Example: "New York"

  - `results.state` (string)
    State or province of the user
    Example: "NY"

  - `results.country` (string)
    Country of the user
    Example: "US"

  - `results.postcode` (string)
    Postal code of the user
    Example: "10001"

  - `results.guardian_name` (string)
    Name of the guardian
    Example: "Jane Doe"

  - `results.guardian_dob` (object)
    Date of birth of the guardian
    Example: "1965-05-15"

  - `results.guardian_age` (number)
    Age of the guardian
    Example: 58

  - `results.data_sharing_agreed` (boolean)
    Whether the user has agreed to data sharing
    Example: true

  - `results.override_status` (string)
    Override status for the user
    Example: "AUTO_APPROVED"

  - `results.override_notes` (string)
    Override notes for the user
    Example: "Manual verification completed"

  - `results.is_deleted` (boolean)
    Whether the user record is deleted

  - `results.selfie_liveness_score` (number)
    Selfie validation score
    Example: 85.05

  - `results.fmc_score` (number)
    FMS (Facial Matching Score)
    Example: 92.21

  - `results.gbg_high_level_result` (string)
    GBG high level result
    Example: "pass"

  - `results.high_level_result` (string)
    High level validation result
    Example: "Passed"

  - `results.document_overall_validation` (string)
    Document overall validation status
    Example: "PASS"

  - `results.registration_submitted` (boolean)
    Whether registration has been submitted
    Example: true

  - `results.registration_status` (string)
    Registration status of the user
    Enum: "Activated", "Rejected", "Referred", "For Review", "Complete", "Deleted"

  - `results.mobile_registration_status` (string)
    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", "REQUEST_DATA_SHARING_AGREEMENT", "REQUEST_PASSWORD", "REGISTRATION_COMPLETED", "PENDING_ID_VERIFICATION", "SELFIE_VERIFICATION", "ID_READ_FAILED", "FACE_READ_FAILED", "VERIFICATION_PASSED", "VERIFICATION_FAILED ", "FACEMATCH_FAILED", "BIRTHDAY_MATCH_FAILED", "ADDRESS_MATCH_FAILED", "NAME_MATCH_FAILED", "REJECTED_ACCESS", "REQUEST_SUBMIT_REGISTRATION", "ADMIN_REVIEW", "DELETED", "REFERRED_APPLICATION"

  - `results.organization_id` (string)
    Organization ID
    Example: "org-123"

  - `results.organization_name` (string)
    Organization name
    Example: "SQR Group"

  - `results.created_at` (object)
    Record creation timestamp
    Example: "2023-01-01T00:00:00Z"

  - `results.id3_pep_sanction_status` (string)
    ID3 match status for PEP and Sanction screening
    Example: "PASS"

  - `results.id3_pep_sanction_result` (object)
    ID3 PEP and Sanction result object
    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.id3_pep_sanction_result.status` (string, required)
    Enum: "Pending", "Cleared", "Flagged"

  - `results.id3_pep_sanction_result.timestamp` (string, required)
    Example: "2025-09-29T10:07:17.623Z"

  - `results.id3_pep_sanction_result.pep_result` (array, required)
    Example: {"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.id3_pep_sanction_result.sanction_result` (array, required)
    Example: {"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_status` (string)
    User status of connection to organization
    Example: "CONNECTED"

  - `results.updated_at` (object)
    Record last update timestamp
    Example: "2023-01-01T00:00:00Z"

  - `pagination` (object, required)
    Pagination information for the current response
    Example: {"limit":10,"offset":0,"total":150}

  - `pagination.limit` (number)
    Maximum number of records to return
    Example: 10

  - `pagination.offset` (number)
    Number of records to skip for pagination

## Response 400 fields (application/json):

  - `code` (number, required)
    Example: 400

  - `errors` (array, required)
    Example: [{"field":"filters","code":"isObject","hint":"filters must be an object"},{"field":"result_keys","code":"isArray","hint":"result_keys must be an array"},{"field":"pagination.limit","code":"isNumber","hint":"pagination.limit must be a number"}]

  - `errors.field` (string)
    Example: "email"

  - `errors.hint` (string)
    Example: "email should not be empty"

## Response 401 fields (application/json):

  - `code` (number, required)
    Example: 401

  - `timestamp` (string, required)
    Example: "2025-07-11T06:51:25.202Z"

  - `path` (string, required)
    Example: "/api/v1/[route]..."

  - `method` (string, required)
    Example: "GET"

  - `error` (string, required)
    Example: "UNAUTHORIZED"

  - `message` (string, required)
    Example: "Unauthorized"

## Response 403 fields (application/json):

  - `code` (number, required)
    Example: 403

  - `timestamp` (string, required)
    Example: "2025-07-11T06:51:25.202Z"

  - `path` (string, required)
    Example: "/api/v1/[route]..."

  - `method` (string, required)
    Example: "GET"

  - `error` (string, required)
    Example: "FORBIDDEN"

  - `message` (string, required)
    Example: "Forbidden"

## Response 404 fields (application/json):

  - `code` (number, required)
    Example: 400

  - `errors` (array, required)
    Example: [{"field":"filters","code":"isObject","hint":"filters must be an object"},{"field":"result_keys","code":"isArray","hint":"result_keys must be an array"},{"field":"pagination.limit","code":"isNumber","hint":"pagination.limit must be a number"}]

  - `errors.field` (string)
    Example: "email"

  - `errors.hint` (string)
    Example: "email should not be empty"

## Response 409 fields (application/json):

  - `code` (number, required)
    Example: 409

  - `timestamp` (string, required)
    Example: "2025-07-11T06:51:25.202Z"

  - `path` (string, required)
    Example: "/api/v1/[route]..."

  - `method` (string, required)
    Example: "GET"

  - `error` (string, required)
    Example: "CONFLICT"

  - `message` (string, required)
    Example: "Conflict"

## Response 5XX fields (application/json):

  - `code` (number, required)
    Example: 503

  - `timestamp` (string, required)
    Example: "2025-07-11T06:51:25.202Z"

  - `path` (string, required)
    Example: "/api/v1/[route]..."

  - `method` (string, required)
    Example: "GET"

  - `error` (string, required)
    Example: "INTERNAL_SERVER_ERROR"

  - `message` (string, required)
    Example: "Internal Server Error"