Smile · Schema
Identity Get Response
CompanyEmployment VerificationCredit ScoringKYCFraud PreventionPhilippines
Properties
| Name | Type | Description |
|---|---|---|
| code | object | |
| message | object | |
| requestId | object | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-identity-get-response-schema.json",
"title": "Identity Get Response",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/getsmileapi-identities-api-openapi.yml#/components/schemas/IdentityGetResponse",
"properties": {
"code": {
"$ref": "#/$defs/ObjectMetadataRefCode"
},
"message": {
"$ref": "#/$defs/ObjectMetadataRefMessage"
},
"requestId": {
"$ref": "#/$defs/ObjectMetadataRefRequestID"
},
"data": {
"$ref": "#/$defs/Identity"
}
},
"$defs": {
"Identity": {
"type": "object",
"title": "Identity",
"description": "The stored identity information of the user from an employment data provider.",
"x-tags": [
"Identities"
],
"allOf": [
{
"$ref": "#/$defs/IdentityPayload"
},
{
"properties": {
"metadata": {
"$ref": "#/$defs/ObjectReferenceMetadata"
}
}
}
],
"required": [
"id",
"fullName",
"emails",
"phones",
"socialProfiles",
"addresses",
"metadata"
]
},
"IdentityPayload": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/RefObjectID"
},
"fullName": {
"type": "string",
"description": "Full name"
},
"firstName": {
"type": [
"string",
"null"
],
"description": "First name"
},
"middleName": {
"type": [
"string",
"null"
],
"description": "Middle name"
},
"lastName": {
"type": [
"string",
"null"
],
"description": "Last name"
},
"suffix": {
"type": [
"string",
"null"
],
"description": "Suffix"
},
"gender": {
"$ref": "#/$defs/RefGender"
},
"dob": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Date of birth"
},
"maritalStatus": {
"$ref": "#/$defs/RefMaritalStatus"
},
"countryResidence": {
"$ref": "#/$defs/RefCountry"
},
"citizenship": {
"type": [
"string",
"null"
],
"enum": [
"Citizen",
"Resident Alien",
"Non-resident Alien",
"Undocumented",
"Others"
],
"description": "Citizenship"
},
"photoUrl": {
"type": [
"string",
"null"
],
"description": "URL to photo or avatar"
},
"referenceId": {
"type": [
"string",
"null"
],
"description": "Reference profile ID from the data provider"
},
"profileUrl": {
"type": [
"string",
"null"
],
"description": "Public profile URL"
},
"latestEmployerName": {
"type": "string",
"deprecated": true,
"description": "The lastest employer name at now, it will be removed in the future."
},
"emails": {
"type": "array",
"description": "A collection of email addresses",
"items": {
"type": "object",
"title": "email",
"properties": {
"address": {
"type": [
"string",
"null"
],
"format": "email",
"description": "Email address"
},
"type": {
"$ref": "#/$defs/RefContactType"
}
},
"required": [
"address",
"type"
]
}
},
"phones": {
"type": "array",
"description": "A collection of phone numbers",
"items": {
"type": "object",
"title": "phone",
"properties": {
"number": {
"$ref": "#/$defs/RefPhoneNumber"
},
"type": {
"$ref": "#/$defs/RefPhoneType"
}
},
"required": [
"number",
"type"
]
}
},
"socialProfiles": {
"type": "array",
"description": "A collection of social media URLs",
"items": {
"type": "object",
"title": "socialProfile",
"properties": {
"socialUrl": {
"type": [
"string",
"null"
],
"description": "URL to social media page"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"Twitter",
"Facebook",
"LinkedIn",
"Others"
],
"description": "Social media type"
}
},
"required": [
"socialUrl",
"type"
]
}
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/$defs/RefAddress"
}
}
},
"required": [
"id",
"fullName",
"emails",
"phones",
"socialProfiles",
"addresses"
]
},
"ObjectMetadataRefCode": {
"type": "string",
"title": "ObjectMetadataRefCode",
"description": "Request status code",
"enum": [
"OK",
"CREATED",
"INVALID_CREDENTIALS",
"INVALID_PARAMETERS",
"INVALID_TOKEN",
"UNAUTHORIZED_ACCESS",
"MISSING_RESOURCE",
"REQUEST_LIMIT_EXCEEDED",
"SERVER_ERROR",
"UNSUPPORTED_METHOD",
"SERVER_UNAVAILABLE",
"TIME_LIMIT_EXCEEDED"
],
"x-internal": false
},
"ObjectMetadataRefMessage": {
"type": "string",
"title": "ObjectMetadataRefMessage",
"description": "Message response to the request",
"x-internal": false
},
"ObjectMetadataRefRequestID": {
"type": "string",
"title": "ObjectMetadataRefRequestID",
"description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
"x-internal": false
},
"ObjectReferenceMetadata": {
"title": "Reference Metadata",
"type": "object",
"description": "Metadata related to account-specific data",
"properties": {
"itemCreatedAt": {
"$ref": "#/$defs/RefDateTime"
},
"createdAt": {
"$ref": "#/$defs/RefDateTime"
},
"accountId": {
"type": "string",
"deprecated": true,
"description": "The accountId of this object"
},
"sourceId": {
"type": "string",
"description": "The ACCOUNT or ARCHIVE ID associated with this object"
},
"sourceType": {
"$ref": "#/$defs/RefSourceType"
},
"userId": {
"type": "string",
"description": "The user ID associated with this object"
},
"providerId": {
"type": "string",
"description": "The provider ID associated with this object"
}
},
"required": [
"createdAt",
"itemCreatedAt",
"sourceId",
"sourceType",
"userId",
"providerId"
]
},
"RefAddress": {
"title": "Address Object",
"type": "object",
"description": "Address object",
"properties": {
"fullAddress": {
"type": [
"string",
"null"
],
"description": "Full address"
},
"line1": {
"type": [
"string",
"null"
],
"description": "Line 1 of street address"
},
"line2": {
"type": [
"string",
"null"
],
"description": "Line 2 of street address"
},
"city": {
"type": [
"string",
"null"
],
"description": "City"
},
"region": {
"type": [
"string",
"null"
],
"description": "Geographic region such as state or province"
},
"zip": {
"type": [
"string",
"null"
],
"description": "Post code"
},
"country": {
"$ref": "#/$defs/RefCountry"
},
"latitude": {
"type": [
"string",
"null"
],
"pattern": "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$",
"description": "Latitude coordinates"
},
"longitude": {
"type": [
"string",
"null"
],
"pattern": "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$",
"description": "Longitude coordinates"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"Primary",
"Secondary",
null
],
"description": "Whether address is primary or secondary"
},
"tags": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"Primary",
"Secondary",
"Home",
"Work",
"Mailing",
"Foreign",
"Billing",
"Permanent",
"Shipping",
null
]
},
"description": "Address tags, such as primary or secondary, home or work, etc."
}
},
"required": [
"type"
]
},
"RefContactType": {
"type": [
"string",
"null"
],
"title": "Contact Types",
"enum": [
"Primary",
"Secondary",
"Work",
"Personal",
null
],
"description": "Primary contact, with secondary marked as either 'Work' or 'Personal'"
},
"RefCountry": {
"type": [
"string",
"null"
],
"title": "Country ISO Codes",
"enum": [
"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
],
"description": "2 character alpha ISO-3166 codes"
},
"RefDateTime": {
"type": "string",
"title": "Date and Time string",
"format": "date-time",
"description": "Date and time"
},
"RefGender": {
"type": "string",
"title": "GenderEnum",
"enum": [
"Male",
"Female",
"Non-binary",
null
],
"description": "Gender"
},
"RefMaritalStatus": {
"type": "string",
"title": "RefMaritalStatus",
"enum": [
"Divorced",
"Married",
"Separated",
"Single",
"Widowed",
"Lifetime Partner",
null
],
"description": "Marital status"
},
"RefObjectID": {
"type": "string",
"title": "Object ID",
"description": "Unique ID of this object"
},
"RefPhoneNumber": {
"type": [
"string",
"null"
],
"title": "International Phone Number",
"pattern": "^\\+[1-9]\\d{1,14}$",
"description": "Phone numbers in international E.164 format"
},
"RefPhoneType": {
"type": [
"string",
"null"
],
"title": "Ref-Phone-Type",
"enum": [
"Mobile",
"Fixed",
"Unspecified",
null
],
"description": "Phone type"
},
"RefSourceType": {
"type": [
"string",
"null"
],
"title": "Ref-Source-Type",
"enum": [
"ACCOUNT",
"UPLOAD",
"ARCHIVE",
"SOCIAL_SECURITY"
],
"description": "Source Type"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/getsmileapi-identity-get-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.