Gridlines

Gridlines Face API

The Face Api API from Gridlines — 1 operation(s) for face api.

Documentation GitHub OpenAPI

Operations 1

POST /face-api/verify Face Match #

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/gridline:gridline-face-api-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

openapi: 3.2.0
info:
  title: Face Match Face API
  version: '1.0'
  description: 'This is an instant Face verification API which can be used to find similarity between two input images. The API takes two images as input, one image would be a selfie and the other would be an image from a verification document. The two images can be provided by urls or as file or even as an encoded Base64 strings.


    > Additon of new fields in all the APIs should be permissible.'
  contact:
    name: OnGrid
    url: ongrid.in
    email: contact@ongrid.in
servers:
- url: https://api.gridlines.io
  description: Production
security:
- X-API-Key: []
tags:
- name: Face Api
paths:
  /face-api/verify:
    parameters: []
    post:
      summary: Face Match
      operationId: post-face-api-face-verify
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - request_id
                - transaction_id
                - data
                - timestamp
                - path
                properties:
                  request_id:
                    type: string
                  transaction_id:
                    type: string
                    x-stoplight:
                      id: r042tatu1xul0
                  reference_id:
                    type: string
                    x-stoplight:
                      id: zu95egjhyar2s
                  status:
                    type: integer
                  data:
                    type: object
                    required:
                    - code
                    - confidence
                    - message
                    properties:
                      code:
                        type: string
                      confidence:
                        type: number
                      message:
                        type: string
                  timestamp:
                    type: number
                  path:
                    type: string
              examples:
                '1000':
                  value:
                    request_id: cd011dd5-d775-4d82-9bc8-609d81b38343
                    status: 200
                    data:
                      code: '1000'
                      confidence: 0.81954
                      message: The two faces belong to the same person.
                    timestamp: 1612932286964
                    path: /verify
                '1001':
                  value:
                    request_id: bb6a1773-8560-41af-8a25-5f57f23cbf03
                    status: 200
                    data:
                      code: '1001'
                      confidence: 0.09098
                      message: The two faces belong to different people.
                    timestamp: 1612932461163
                    path: /verify
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_id:
                    type: string
                  transaction_id:
                    type: string
                  status:
                    type: integer
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      type:
                        type: string
                  timestamp:
                    type: integer
                  path:
                    type: string
                x-examples:
                  Example 1:
                    request_id: 1446c4eb-2eb7-4597-9a97-15cb10cf720f
                    transaction_id: b16bb6b4-114a-48f2-9873-06934bcd0bc3
                    status: 400
                    error:
                      code: INVALID_FILE_SIZE
                      message: 'File 1 has an invalid file size. Permitted Size: 1KB - 6 MB'
                      type: https://gridlines.stoplight.io/#:~:text=400-,INVALID_FILE_SIZE,-Invalid%20file%20size
                    timestamp: 1782713178654
                    path: /face-api/verify
              examples:
                INVALID_URL:
                  value:
                    request_id: d974d8fd-5250-4ced-ae7f-d4c914d9601e
                    status: 400
                    error:
                      code: INVALID_URL
                      message: 'Invalid image URL or error downloading from target server. Remote server error returned: "Response status code does not indicate success: 403 (Forbidden)."'
                      type: https://docs.gridlines.io/#:~:text=400-,INVALID_URL,-Invalid%20url
                    timestamp: 1643782265525
                    path: /verify
                Example 1:
                  value:
                    request_id: d974d8fd-5250-4ced-ae7f-d4c914d9601d
                    transaction_id: b16bb6b4-114a-48f2-9873-06934bcd0bc4
                    status: 400
                    error:
                      code: INVALID_FILE_SIZE
                      message: 'File 1 has an invalid file size. Permitted Size: 1KB - 6 MB'
                      type: https://gridlines.stoplight.io/#:~:text=400-,INVALID_FILE_SIZE,-Invalid%20file%20size
                    timestamp: 1782713178654
                    path: /face-api/verify
      description: 'This API takes two image files or urls or base64 encoded strings of the images to be verified as inputs and provides a confidence index for determining similarity between the two images supplied. If the confidence score is <0.25 then it is determined as different persons or else it is determined as same person. The clients can even use the confidence score to determine their own threshold depending on quality of images in their sample set. The default threshold of 0.25 is only suggestive.


        Response Codes:


        | Sl | Status | Code | Description

        | ---- | -------|-------------------| -------------

        | 1 | 200 | 1000 | The two faces belong to the same person.

        | 2 | 200 | 1001 | The two faces belong to different people.'
      security:
      - X-API-Key: []
      parameters:
      - schema:
          type: string
          default: API-Key
        in: header
        name: X-Auth-Type
        description: API-Key
        required: true
      - schema:
          type: string
        in: header
        name: X-Reference-ID
        description: Reference ID
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                file_1:
                  type: string
                  description: 'The provided file should not be more than 6 MB, should not have more than 1 face and only PNG, JPEG, BMP and GIF images are allowed. '
                file_2:
                  type: string
                  description: 'The provided file should not be more than 6 MB, should not have more than 1 face and only PNG, JPEG, BMP and GIF images are allowed. '
                file_1_base64:
                  type: string
                file_2_base64:
                  type: string
                file_1_url:
                  type: string
                file_2_url:
                  type: string
                consent:
                  type: string
                  enum:
                  - Y
                  - N
                  description: The consent of the client should also be provided as a string, "Y" for an YES and "N" for NO.
              required:
              - file_1
              - file_2
              - file_1_base64
              - file_2_base64
              - file_1_url
              - file_2_url
              - consent
            examples:
              example-1:
                value:
                  file_1_url: https://drive.google.com/file/d/0B7TM5QXXXXXXXXXXXXXZ0/view?usp=sharing
                  file_2_url: https://drive.google.com/file/d/0B7YYYYYYYYYYYvW/view?usp=sharing
                  consent: Y
              example-2:
                value:
                  file_1_base64: Encoded Base64 string
                  file_2_base64: Encoded Base64 string
                  consent: Y
        description: 'Both the inputs to the API should be of the same type i.e can be both files or file urls or encoded base64 strings. Mixed inputs of any sorts will not be acceptable to the API. '
      tags:
      - Face Api
components:
  securitySchemes:
    X-API-Key:
      name: X-API-Key
      type: apiKey
      in: header
x-stoplight:
  id: f0852be7ddcf2
x-internal: false