Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keyo Identities API

Manage biometric identities and palm enrollment.

Keyo Identities API is one of 2 APIs that Keyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Identities. The published artifact set on APIs.io includes an OpenAPI specification and an AsyncAPI specification.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.keyo.co/v1, https://api.africa.keyo.co/v1.

6 operations 3 paths 8 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.keyo.co/v1
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Keyo Identities API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It accepts HTTP bearer tokens () (Bearer). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Identities 6

Manage biometric identities and palm enrollment.

GET
/identities/
Retrieve a list of identities
IdentitiesGet 2 params → 200
POST
/identities/
Create an identity
IdentitiesPost body → 201
GET
/identities/{id}/
Retrieve single identity
IdentityGet 1 param → 200
PATCH
/identities/{id}/
Update identity
IdentitiesPatch 1 param body → 200
DELETE
/identities/{id}/
Delete identity
IdentitiesDelete 1 param → 204
POST
/identities/{id}/start-enroll/
Start biometric enrollment
IdentitiesStartEnroll 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are IdentityBase (4 properties), IdentityList (4 properties), Dates (2 properties), Metadata (1 property). Each schema is shown below with its type and property counts.

IdentityBodyUpdate
object
IdentityBodyCreate
object
2 required
IdentityList
object
4 properties
Identity
object
IdentityBase
object
4 properties
Dates
object
2 properties
Metadata
object
1 property
Id
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keyo-identities-api-openapi.yml Raw ↑

Other APIs Keyo publishes across the network.

Keyo Authentication API