Smile

Smile Identities API

The Identities API from Smile — 2 operation(s) for identities.

GitHub OpenAPI

Operations 2

GET /identities List Identities #
GET /identities/{id} Get Identity #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/openapi/getsmileapi-identities-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-invite-template-update-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-invite-template-post-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-verification-create-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-invite-post-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-schemas-social-security-post-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/json-schema/getsmileapi-webhook-post-request-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-identities-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getsmileapi-identities-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Smile Identities API
  version: 1.14.0
  description: The Smile API provides employment and income data from a single API.
  contact:
    name: Smile Technology Pte Ltd
    url: https://www.getsmileapi.com
    email: info@getsmileapi.com
  termsOfService: https://www.getsmileapi.com/terms-and-conditions
servers:
- url: https://sandbox.smileapi.io/v1
  description: Sandbox
- url: https://open.smileapi.io/v1
  description: Production
security:
- basicAuth: []
tags:
- name: Identities
paths:
  /identities:
    parameters: []
    get:
      summary: List Identities
      tags:
      - Identities
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: '1259723474'
                      items:
                      - id: i-17bbf36498de4d68a0d4f86c7b62f69f
                        fullName: George Cimafranca Palomero, Jr
                        firstName: George
                        middleName: Cimafranca
                        lastName: Palomero
                        suffix: Jr
                        gender: Male
                        dob: '1970-08-24'
                        maritalStatus: Married
                        countryResidence: PH
                        citizenship: Citizen
                        photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg
                        referenceId: george
                        profileUrl: https://upwork.com/profiles/george.jpg
                        emails:
                        - address: gpalomero1234@yahoo.com
                          type: Primary
                        phones:
                        - number: '+639175551234'
                          type: Mobile
                        socialProfiles:
                        - socialUrl: https://www.facebook.com/gpalomero
                          type: Facebook
                        addresses:
                        - fullAddress: 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH
                          line1: 12 Maybunga St
                          line2: Barangay Paraiso
                          city: Pasig City
                          region: NCR
                          zip: '1600'
                          country: PH
                          latitude: '14.573454'
                          longitude: '121.085042'
                          type: Primary
                        metadata:
                          createdAt: '2021-04-14T09:30:24Z'
                          sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                          sourceType: ACCOUNT
                          userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                          providerId: upwork
                      - id: i-24bbf36498ac4d26a0d4f86c7b62f83z
                        fullName: Ryan Joseph Peterson Chua Ng
                        firstName: Ryan Joseph Peterson
                        middleName: Chua
                        lastName: Ng
                        suffix: null
                        gender: Male
                        dob: '1995-06-24'
                        maritalStatus: Single
                        countryResidence: null
                        citizenship: Citizen
                        photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/ryan.jpg
                        referenceId: ~02c0bf6ae6a581ee2b
                        profileUrl: https://www.upwork.com/freelancers/~02c0bf6ae6a581ee2b
                        emails:
                        - address: ryan1234@gmail.com
                          type: Primary
                        phones:
                        - number: '+639559994321'
                          type: Mobile
                        - number: '+63289053000'
                          type: Fixed
                        socialProfiles:
                        - socialUrl: https://www.facebook.com/ryanpetersonng
                          type: Facebook
                        - socialUrl: https://www.twitter.com/xklxyz
                          type: Twitter
                        addresses:
                        - fullAddress: 24 Eagle St, Binondo, Manila, NCR, 1008, PH
                          line1: 24 Eagle St
                          line2: Binondo
                          city: Manila
                          region: NCR
                          zip: '1008'
                          country: PH
                          latitude: '14.600454'
                          longitude: '120.969042'
                          type: Primary
                        metadata:
                          createdAt: '2021-04-14T09:30:24Z'
                          sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                          sourceType: ACCOUNT
                          userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                          providerId: upwork
                      - id: i-48ace87698bd6e67a0d4f86c7b62h76c
                        fullName: Christina Tan
                        firstName: Christina
                        middleName: dela Cruz
                        lastName: Tan
                        suffix: null
                        gender: Female
                        dob: '1997-02-12'
                        maritalStatus: Single
                        countryResidence: null
                        citizenship: Citizen
                        photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/christina.jpg
                        referenceId: null
                        profileUrl: null
                        emails:
                        - address: christina4321@yahoo.com
                          type: Primary
                        phones:
                        - number: '+639559996789'
                          type: Mobile
                        - number: '+639226789888'
                          type: Mobile
                        socialProfiles: []
                        addresses:
                        - fullAddress: null
                          line1: null
                          line2: null
                          city: null
                          region: null
                          zip: null
                          country: PH
                          latitude: null
                          longitude: null
                          type: Primary
                        metadata:
                          createdAt: '2021-04-14T09:30:24Z'
                          sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                          sourceType: ACCOUNT
                          userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                          providerId: upwork
      operationId: list-identities
      description: Get a user's identity profiles from employment data sources.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/sourceId'
  /identities/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: Get Identity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: i-17bbf36498de4d68a0d4f86c7b62f69f
                      fullName: George Cimafranca Palomero, Jr
                      firstName: George
                      middleName: Cimafranca
                      lastName: Palomero
                      suffix: Jr
                      gender: Male
                      dob: '1970-08-24'
                      maritalStatus: Married
                      countryResidence: PH
                      citizenship: Citizen
                      photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg
                      referenceId: george
                      profileUrl: https://upwork.com/profiles/george.jpg
                      emails:
                      - address: gpalomero1234@yahoo.com
                        type: Primary
                      phones:
                      - number: '+639175551234'
                        type: Mobile
                      socialProfiles:
                      - socialUrl: https://www.facebook.com/gpalomero
                        type: Facebook
                      addresses:
                      - fullAddress: 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH
                        line1: 12 Maybunga St
                        line2: Barangay Paraiso
                        city: Pasig City
                        region: NCR
                        zip: '1600'
                        country: PH
                        latitude: '14.573454'
                        longitude: '121.085042'
                        type: Primary
                      metadata:
                        createdAt: '2021-04-14T09:30:24Z'
                        sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
                        sourceType: ACCOUNT
                        userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
                        providerId: upwork
      operationId: get-identity
      description: Get the user's identity profile by ID.
      tags:
      - Identities
      parameters: []
components:
  schemas:
    IdentityGetResponse:
      title: Identity Get Response
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Identity'
      x-examples: {}
    RefContactType:
      type:
      - string
      - 'null'
      title: Contact Types
      enum:
      - Primary
      - Secondary
      - Work
      - Personal
      - null
      description: Primary contact, with secondary marked as either 'Work' or 'Personal'
      example: Primary
    RefPhoneType:
      type:
      - string
      - 'null'
      title: Ref-Phone-Type
      example: Mobile
      enum:
      - Mobile
      - Fixed
      - Unspecified
      - null
      description: Phone type
    RefObjectID:
      type: string
      title: Object ID
      description: Unique ID of this object
      example: 17bbf36498de4d68a0d4f86c7b62f69f
    ObjectMetadataRefMessage:
      type: string
      title: ObjectMetadataRefMessage
      description: Message response to the request
      example: Success
      x-internal: false
    IdentityListResponse:
      title: Identity List Response
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/IdentityListData'
      x-examples: {}
    IdentityListData:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/ObjectNextCursor'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
    ObjectReferenceMetadata:
      title: Reference Metadata
      type: object
      description: Metadata related to account-specific data
      properties:
        itemCreatedAt:
          $ref: '#/components/schemas/RefDateTime'
        createdAt:
          $ref: '#/components/schemas/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: '#/components/schemas/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
    RefMaritalStatus:
      type: string
      title: RefMaritalStatus
      enum:
      - Divorced
      - Married
      - Separated
      - Single
      - Widowed
      - Lifetime Partner
      - null
      example: Married
      description: Marital status
    RefSourceType:
      type:
      - string
      - 'null'
      title: Ref-Source-Type
      example: Account
      enum:
      - ACCOUNT
      - UPLOAD
      - ARCHIVE
      - SOCIAL_SECURITY
      description: Source Type
    RefGender:
      type: string
      title: GenderEnum
      enum:
      - Male
      - Female
      - Non-binary
      - null
      example: Male
      description: Gender
    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
      example: OK
      x-internal: false
    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: '#/components/schemas/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: []
          example:
          - Primary
          - Home
          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
    RefDateTime:
      type: string
      title: Date and Time string
      format: date-time
      example: '2021-04-14T09:30:24Z'
      description: Date and time
    RefPhoneNumber:
      type:
      - string
      - 'null'
      title: International Phone Number
      pattern: ^\+[1-9]\d{1,14}$
      description: Phone numbers in international E.164 format
      example: '+639175551234'
    IdentityPayload:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        fullName:
          type: string
          example: George Cimafranca Palomero, Jr
          description: Full name
        firstName:
          type:
          - string
          - 'null'
          example: George
          description: First name
        middleName:
          type:
          - string
          - 'null'
          example: Cimafranca
          description: Middle name
        lastName:
          type:
          - string
          - 'null'
          example: Palomero
          description: Last name
        suffix:
          type:
          - string
          - 'null'
          example: Jr
          description: Suffix
        gender:
          $ref: '#/components/schemas/RefGender'
        dob:
          type:
          - string
          - 'null'
          format: date
          description: Date of birth
        maritalStatus:
          $ref: '#/components/schemas/RefMaritalStatus'
        countryResidence:
          $ref: '#/components/schemas/RefCountry'
        citizenship:
          type:
          - string
          - 'null'
          enum:
          - Citizen
          - Resident Alien
          - Non-resident Alien
          - Undocumented
          - Others
          description: Citizenship
        photoUrl:
          type:
          - string
          - 'null'
          example: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg
          description: URL to photo or avatar
        referenceId:
          type:
          - string
          - 'null'
          description: Reference profile ID from the data provider
          example: ~02c0bf6ae6a581ee2b
        profileUrl:
          type:
          - string
          - 'null'
          description: Public profile URL
          example: https://www.upwork.com/freelancers/~02c0bf6ae6a581ee2b
        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
                example: gpalomero@yahoo.com
                description: Email address
              type:
                $ref: '#/components/schemas/RefContactType'
            required:
            - address
            - type
        phones:
          type: array
          description: A collection of phone numbers
          items:
            type: object
            title: phone
            properties:
              number:
                $ref: '#/components/schemas/RefPhoneNumber'
              type:
                $ref: '#/components/schemas/RefPhoneType'
            required:
            - number
            - type
        socialProfiles:
          type: array
          description: A collection of social media URLs
          items:
            type: object
            title: socialProfile
            properties:
              socialUrl:
                type:
                - string
                - 'null'
                example: https://www.facebook.com/gpalomero
                description: URL to social media page
              type:
                type:
                - string
                - 'null'
                enum:
                - Twitter
                - Facebook
                - LinkedIn
                - Others
                example: Facebook
                description: Social media type
            required:
            - socialUrl
            - type
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/RefAddress'
      required:
      - id
      - fullName
      - emails
      - phones
      - socialProfiles
      - addresses
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    Identity:
      type: object
      title: Identity
      description: The stored identity information of the user from an employment data provider.
      x-examples:
        Example:
          id: i-17bbf36498de4d68a0d4f86c7b62f69f
          fullName: George Cimafranca Palomero, Jr
          firstName: George
          middleName: Cimafranca
          lastName: Palomero
          suffix: Jr
          gender: Male
          dob: '1970-08-24'
          maritalStatus: Married
          countryResidence: PH
          citizenship: Citizen
          photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg
          referenceId: null
          profileUrl: null
          emails:
          - address: gpalomero1234@yahoo.com
            type: Primary
          phones:
          - number: '+639559991234'
            type: Mobile
          socialProfiles:
          - socialUrl: https://www.facebook.com/gpalomero
            type: Facebook
          addresses:
          - fullAddress: 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH
            line1: 12 Maybunga St
            line2: Barangay Paraiso
            city: Pasig City
            region: NCR
            zip: '1600'
            country: PH
            latitude: '14.573454'
            longitude: '121.085042'
            type: Primary
          metadata:
            createdAt: '2021-04-14T09:30:24Z'
            itemCreatedAt: '2021-04-14T09:30:26Z'
            sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f
            sourceType: ACCOUNT
            userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8
            providerId: upwork
      x-tags:
      - Identities
      allOf:
      - $ref: '#/components/schemas/IdentityPayload'
      - properties:
          metadata:
            $ref: '#/components/schemas/ObjectReferenceMetadata'
      required:
      - id
      - fullName
      - emails
      - phones
      - socialProfiles
      - addresses
      - metadata
    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
      example: 5b79399a-6852-4234-bb0e-ad472648282d
    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
      example: PH
  parameters:
    sourceId:
      name: sourceId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId
    id:
      name: id
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 200
      description: ID of the specific object in the collection.
      required: true
    userId:
      name: userId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular user ID.
    accountId:
      name: accountId
      in: query
      required: false
      schema:
        type: string
      description: Filter to those associated with a particular account ID.
      deprecated: true
    cursor:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: Uses the filter values of the previous page to determine the next set of items.
    size:
      name: size
      in: query
      schema:
        type: integer
        example: 50
        minimum: 1
        maximum: 150
        default: 10
      description: The number of objects you want returned in a collection.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-provenance:
  method: searched
  source: https://docs.getsmileapi.com/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.getsmileapi.com/reference/create-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/create-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/create-alpha-maw.md
  - https://docs.getsmileapi.com/reference/create-alpha-signal.md
  - https://docs.getsmileapi.com/reference/create-and-classify-archive.md
  - https://docs.getsmileapi.com/reference/create-archive.md
  - https://docs.getsmileapi.com/reference/create-beta-maw2.md
  - https://docs.getsmileapi.com/reference/create-beta-maw3.md
  - https://docs.getsmileapi.com/reference/create-beta-signal.md
  - https://docs.getsmileapi.com/reference/create-beta-signal2.md
  - https://docs.getsmileapi.com/reference/create-beta-signal3.md
  - https://docs.getsmileapi.com/reference/create-beta-social-security.md
  - https://docs.getsmileapi.com/reference/create-consent-template.md
  - https://docs.getsmileapi.com/reference/create-invite-template.md
  - https://docs.getsmileapi.com/reference/create-invite.md
  - https://docs.getsmileapi.com/reference/create-token-1.md
  - https://docs.getsmileapi.com/reference/create-user-1.md
  - https://docs.getsmileapi.com/reference/create-verification.md
  - https://docs.getsmileapi.com/reference/create-webhook.md
  - https://docs.getsmileapi.com/reference/delete-account.md
  - https://docs.getsmileapi.com/reference/delete-archive.md
  - https://docs.getsmileapi.com/reference/delete-consent-template.md
  - https://docs.getsmileapi.com/reference/delete-invite-template.md
  - https://docs.getsmileapi.com/reference/delete-webhook.md
  - https://docs.getsmileapi.com/reference/disable-account-monitor.md
  - https://docs.getsmileapi.com/reference/generate-account-export.md
  - https://docs.getsmileapi.com/reference/get-account-1.md
  - https://docs.getsmileapi.com/reference/get-account-payload.md
  - https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/get-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/get-alpha-form.md
  - https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/get-alpha-maw.md
  - https://docs.getsmileapi.com/reference/get-alpha-signal.md
  - https://docs.getsmileapi.com/reference/get-archive.md
  - https://docs.getsmileapi.com/reference/get-beta-maw.md
  - https://docs.getsmileapi.com/reference/get-beta-signal.md
  - https://docs.getsmileapi.com/reference/get-beta-social-security.md
  - https://docs.getsmileapi.com/reference/get-contribution.md
  - https://docs.getsmileapi.com/reference/get-document-1.md
  - https://docs.getsmileapi.com/reference/get-eincomes.md
  - https://docs.getsmileapi.com/reference/get-employment-1.md
  - https://docs.getsmileapi.com/reference/get-feature-insight.md
  - https://docs.getsmileapi.com/reference/get-identity-1.md
  - https://docs.getsmileapi.com/reference/get-income-1.md
  - https://docs.getsmileapi.com/reference/get-invite-template.md
  - https://docs.getsmileapi.com/reference/get-invite.md
  - https://docs.getsmileapi.com/reference/get-liabilities.md
  - https://docs.getsmileapi.com/reference/get-link.md
  - https://docs.getsmileapi.com/reference/get-provider-1.md
  - https://docs.getsmileapi.com/reference/get-rating-1.md
  - https://docs.getsmileapi.com/reference/get-task.md
  - https://docs.getsmileapi.com/reference/get-transaction-1.md
  - https://docs.getsmileapi.com/reference/get-user-1.md
  - https://docs.getsmileapi.com/reference/get-user-session-payload.md
  - https://docs.getsmileapi.com/reference/get-verification.md
  - https://docs.getsmileapi.com/reference/get-webhook.md
  - https://docs.getsmileapi.com/reference/list-accounts-1.md
  - https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
  - https://docs.getsmileapi.com/reference/list-alpha-footprints.md
  - https://docs.getsmileapi.com/reference/list-alpha-forms.md
  - https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
  - https://docs.getsmileapi.com/reference/list-alpha-maws.md
  - https://docs.getsmileapi.com/reference/list-alpha-signals.md
  - https://docs.getsmileapi.com/reference/list-archives.md
  - https://docs.getsmileapi.com/reference/list-beta-maws.md
  - https://docs.getsmileapi.com/reference/list-beta-signals.md
  - https://docs.getsmileapi.com/reference/list-beta-social-securities.md
  - https://docs.getsmileapi.com/reference/list-consent-templates.md
  - https://docs.getsmileapi.com/reference/list-contributions.md
  - https://docs.getsmileapi.com/reference/list-documents-1.md
  - https://docs.getsmileapi.com/reference/list-eincomes.md
  - https://docs.getsmileapi.com/reference/list-employments-1.md
  - https://docs.getsmileapi.com/reference/list-file-types.md
  - https://docs.getsmileapi.com/reference/list-identities-1.md
  - https://docs.getsmileapi.com/reference/list-incomes-1.md


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/openapi/getsmileapi-identities-api-openapi.yml