FaceSDK-web-openapi/index.yml at develop · regulaforensics/FaceSDK-web-openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
openapi: 3.0.4
info:
  version: 7.2.0
  title: Regula Face SDK Web API
  x-logo:
    url: "https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg"
    href: "https://mobile.regulaforensics.com/"
  description: |
    <a href="https://regulaforensics.com/products/face-recognition-sdk/  " target="_blank">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.

    The Face SDK includes the following features:

    * <a href="https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection" target="_blank">Face detection and image quality assessment</a>
    * <a href="https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11" target="_blank">Face match (1:1)</a>
    * <a href="https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n" target="_blank">Face search (1:N)</a>
    * <a href="https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment" target="_blank">Liveness detection</a>

    Here is the <a href="https://github.com/regulaforensics/FaceSDK-web-openapi  " target="_blank">OpenAPI specification on GitHub</a>.

    ### Clients
    * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios
    * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android
    * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client
    * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core

x-tagGroups:
  - name: Core
    tags:
      - match
      - person
      - group
      - search
      - liveness 2.0
  - name: Requests
    tags:
      - healthcheck

servers:
  - url: https://faceapi.regulaforensics.com/
    description: Latest stable Regula face demo endpoint
  - url: https://nightly-faceapi.regulaforensics.com/
    description: Nightly Regula face demo endpoint
  - url: http://localhost:41101/
    description: Local on-premise installation

# ~1 means '/', %7B means '{', %7D means '}'
paths:
  /api/match:
    $ref: "./match.yml#/paths/~1match"
  /api/match_and_search:
    $ref: "./match_and_search.yml#/paths/~1match_and_search"
  /api/detect:
    $ref: "./detect.yml#/paths/~1detect"
  /api/persons:
    $ref: "./persons.yml#/paths/~1persons"
  /api/persons/{personId}:
    $ref: "./persons.yml#/paths/~1persons~1%7BpersonId%7D"
  /api/persons/{personId}/images:
    $ref: "./persons.yml#/paths/~1persons~1%7BpersonId%7D~1images"
  /api/persons/{personId}/images/{imageId}:
    $ref: "./persons.yml#/paths/~1persons~1%7BpersonId%7D~1images~1%7BimageId%7D"
  /api/persons/{personId}/groups:
    $ref: "./persons.yml#/paths/~1persons~1%7BpersonId%7D~1groups"
  /api/groups:
    $ref: "./groups.yml#/paths/~1groups"
  /api/groups/{groupId}:
    $ref: "./groups.yml#/paths/~1groups~1%7BgroupId%7D"
  /api/groups/{groupId}/persons:
    $ref: "./groups.yml#/paths/~1groups~1%7BgroupId%7D~1persons"
  /api/search:
    $ref: "./search.yml#/paths/~1search"
  /api/v2/liveness:
    $ref: "./liveness.yml#/paths/~1v2~1liveness"
  /api/healthz:
    $ref: "./healthcheck.yml#/paths/~1healthz"
  /api/readyz:
    $ref: "./healthcheck.yml#/paths/~1readyz"