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.
openapi: 3.2.0
info:
title: ADVANCE.AI Open Face Recognition API
version: '1.0'
description: ADVANCE.AI is the digital identity verification, KYC/KYB, AML and risk management business unit of Advance Intelligence Group.
contact:
name: ADVANCE.AI Business Development
url: https://advance.ai/contact-us/
termsOfService: https://advance.ai/terms-of-service/
servers:
- url: https://api.advance.ai
description: Global production host
- url: https://sg-api.advance.ai
description: Singapore regional host
security:
- AccessToken: []
tags:
- name: Face Recognition
description: Face comparison and biometric matching.
paths:
/openapi/face-recognition/v4/check:
post:
tags:
- Face Recognition
operationId: faceComparison
summary: Compare two faces
description: Compare two photographs and return a similarity score (0-100) plus the detected face position in each image.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/FaceComparisonRequest'
responses:
'200':
description: Comparison result (or a business error in the envelope).
content:
application/json:
schema:
$ref: '#/components/schemas/FaceComparisonResponse'
components:
schemas:
FaceComparisonResponse:
allOf:
- $ref: '#/components/schemas/Envelope'
- type: object
properties:
data:
type: object
properties:
similarity:
type: number
description: Similarity score from 0 to 100.
firstFace:
type: object
description: Detected face position in the first image.
secondFace:
type: object
description: Detected face position in the second image.
Envelope:
type: object
description: Common response envelope shared by all ADVANCE.AI Open API operations.
properties:
code:
type: string
description: Business status code (e.g. SUCCESS, PARAMETER_ERROR, ACCESS_DENIED).
example: SUCCESS
message:
type: string
description: Human-readable explanation of the status code.
extra:
type: string
description: Exception detail, present on some error responses.
transactionId:
type: string
maxLength: 64
description: Request identifier echoed back for tracing.
pricingStrategy:
type: string
enum:
- FREE
- PAY
description: Whether the call was billable.
required:
- code
FaceComparisonRequest:
type: object
required:
- firstImage
- secondImage
properties:
firstImage:
type: string
format: binary
description: First photograph for comparison.
secondImage:
type: string
format: binary
description: Second photograph for comparison.
securitySchemes:
AccessToken:
type: apiKey
in: header
name: X-ACCESS-TOKEN
description: Access token obtained from POST /openapi/auth/ticket/v1/generate-token.
externalDocs:
description: ADVANCE.AI API Documentation
url: https://doc.advance.ai/