---
title: "Query Identity"
method: POST
path: "/profiles/-/identities/query"
tags: ["Profile Data"]
---

# Query Identity

`POST /profiles/-/identities/query`

## Request body

- ProfileIdentityQueryRequest
  - `idType` 'SSS', required — The identification type, currently only support SSS
  - `idNumber` string, required — Identification number
  - `firstName` string, required — User first name
  - `lastName` string — User last name
  - `dob` string, date — The day of birthday, yyyy-MM-dd

## Response `200`

OK

- ProfileIdentityQueryResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED', required — Request status code
  - `message` string — Message response to the request
  - `requestId` string, required — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` ProfileIdentity
    - `hit` boolean, required — if the identification number is invalid or it can not be found then the value is false
    - `message` string
    - `result` object
      - `nameMatchScore` integer, required — The score if matched the name(first name, last name). If matched(score >= 80), then Smile will return the matched information. If not matched, all other fields will return null
      - `firstName` string — The firstName from Smile side
      - `lastName` string — The lastName from Smile side
      - `middleName` string — The middleName from Smile side
      - `suffix` string — The suffix from Smile side
      - `dob` string, date — The day of birthday, yyyy-MM-dd
      - `mobile` string — Mobile number
      - `email` string — Email address
      - `gender` string — Gender
      - `maritalStatus` string — Marital status
      - `homeTelephone` string — home telephone number
      - `address` ProfileIdentityAddress
        - `line1` string, nullable — Line 1 of street address
        - `line2` string, nullable — Line 2 of street address
        - `city` string, nullable — City
        - `region` string, nullable — Geographic region such as state or province
        - `zip` string, nullable — Post code
        - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RS' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'XT' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'null', nullable — 2 character alpha ISO-3166 codes
      - `socialSecurityCoverageType` string — Social security coverage type, Possible values: EMPLOYEE, VOLUNTARY, SELF EMPLOYED, FOR EMPLOYMENT
      - `socialSecurityCoverageDate` string, date — Social security start time
      - `totalEmploymentReportCount` integer — the total of employment report records
      - `firstEmploymentReportDate` string, date — First employment record reported date
      - `latestEmploymentReportDate` string, date — Latest employment record reported date

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/2e8500e069bb/schema)