Skip to main content
API docs by Redocly

API Documentation (1.0.0)

Download OpenAPI specification:Download

Authentication Data

Get authentication by Entrupy ID

Returns status, result, certificate, catalog, and image information for a specific authentication session.

path Parameters
entrupy_id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "item": {
    }
}

Lookup authentication by Customer ID

Retrieve the latest authentication for an item using your own customer_item_id. This helps correlate Entrupy results with records in your inventory system.

path Parameters
lookup_value
required
string

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Search authentications

Search your organization's authentication history using flexible filters. This endpoint powers dashboards and reporting without requiring you to store all results locally.

Request Body schema: application/json
required
Limit (integer) or Limit (null) (Limit)
Default: 10

Maximum number of results to return (max 25).

Array of Filters (objects) or Filters (null) (Filters)
Default: null

List of filters to apply to the search results.

Format Options (object) or Format Options (null) (Format Options)
Default: null

Advanced formatting options for results.

property name*
additional property
any

Responses

Request samples

Content type
application/json
Example
{
  • "limit": 10,
  • "filters": [
    ],
  • "format_options": null
}

Response samples

Content type
application/json
Example
{
  • "items": [
    ],
  • "item_count": 2,
  • "next_cursor": "CURSOR_FOR_NEXT_PAGE_ABC456"
}

Authentication Actions

Flag an authentication

Submits a flag for an authentication result.

path Parameters
entrupy_id
required
string
Request Body schema: application/json
required
reason
required
string (Reason)
Comments (string) or Comments (null) (Comments)
Default: null

Responses

Request samples

Content type
application/json
{
  • "reason": "Suspected counterfeit based on stitching pattern.",
  • "comments": "Compared with retail version, stitching is inconsistent."
}

Response samples

Content type
application/json
{
  • "entrupy_id": "ENTPYFLAG123",
  • "flag_status": "pending_review",
  • "message": "Flag submitted successfully for Entrupy ID: ENTPYFLAG123. Reason: Suspected counterfeit based on stitching pattern."
}

Initiate B2B non-verified certificate transfer

Initiates a B2B non-verified transfer of an Entrupy certificate.

path Parameters
entrupy_id
required
string
Request Body schema: application/json
required
recipient_platform_id
required
string (Recipient Platform Id)
Recipient User Email (string) or Recipient User Email (null) (Recipient User Email)
Default: null
Notes (string) or Notes (null) (Notes)
Default: null

Responses

Request samples

Content type
application/json
Example
{
  • "recipient_platform_id": "PARTNER_PLATFORM_ID_789",
  • "recipient_user_email": null,
  • "notes": "Standard B2B transfer of ownership."
}

Response samples

Content type
application/json
{
  • "entrupy_id": "ENTPYTRANSFER456",
  • "transfer_status": "initiated",
  • "new_holder_information": "Transfer initiated to PARTNER_PLATFORM_ID_789.",
  • "message": "Certificate transfer initiated for ENTPYTRANSFER456."
}

Fingerprint Data

Get fingerprint by Entrupy ID

Return the fingerprint record for an item. Use this endpoint when verifying that a new submission matches the original fingerprint stored by Entrupy.

path Parameters
entrupy_id
required
string

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Search fingerprints

Search fingerprint records to track items that have been registered for identity verification. Filters let you narrow results to specific users or metadata.

Request Body schema: application/json
required
Limit (integer) or Limit (null) (Limit)
Default: 10

Maximum number of results to return (max 25).

Array of Filters (objects) or Filters (null) (Filters)
Default: null

List of filters to apply to the search results.

Format Options (object) or Format Options (null) (Format Options)
Default: null

Advanced formatting options for results.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "limit": 5,
  • "filters": [
    ],
  • "format_options": null
}

Response samples

Content type
application/json
Example
{
  • "items": [
    ],
  • "item_count": 1,
  • "next_cursor": "CURSOR_FOR_NEXT_PAGE_FP"
}

Integrations

Authentication config

Return brand and material options your token can access. Use this data to populate capture forms in your app and ensure requests use valid values.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "iat": 1678886400,
  • "exp": 1678972800
}

Create login voucher

Generate an encrypted login voucher for the mobile app. This legacy flow allows a user to sign in to Entrupy before the authorize-user method was introduced.

Request Body schema: application/json
required
unique_user_id
required
string (Unique User Id)

A unique identifier for the user within your system.

email
required
string (Email)

The user's email address.

First Name (string) or First Name (null) (First Name)
Default: null

The user's first name.

Last Name (string) or Last Name (null) (Last Name)
Default: null

The user's last name.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "unique_user_id": "testuser123",
  • "email": "testuser123@example.com",
  • "first_name": "Test",
  • "last_name": "User"
}

Response samples

Content type
application/json
{
  • "login_voucher": "<encrypted_voucher_string>",
  • "username": "YourOrg-testuser123"
}

Authorize user

Sign an authorization request from your mobile client so the SDK can obtain a session token from Entrupy. This is the preferred workflow for new integrations.

Request Body schema: application/json
required
unique_user_id
required
string (Unique User Id)

A unique identifier for the user within your system.

email
required
string (Email)

The user's email address.

sdk_authorization_request
required
string (Sdk Authorization Request)

The authorization request string generated by the Entrupy SDK.

First Name (string) or First Name (null) (First Name)
Default: null

The user's first name.

Last Name (string) or Last Name (null) (Last Name)
Default: null

The user's last name.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "unique_user_id": "test-sdk-user-789",
  • "email": "test-sdk-user-789@example.com",
  • "sdk_authorization_request": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  • "first_name": "SDKTest",
  • "last_name": "User"
}

Response samples

Content type
application/json
{
  • "signed_authorization_request": "<signed_sdk_authorization_request_payload>",
  • "username": "YourOrg-test-sdk-user-789"
}

Webhooks

Search registered domains

List domain names that have been verified for use with webhook callbacks. Webhooks can only target these domains.

Request Body schema: application/json
required
Limit (integer) or Limit (null) (Limit)
Default: 25
Cursor (string) or Cursor (null) (Cursor)
Default: null
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "cursor": null
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "item_count": 1,
  • "next_cursor": null
}

Create webhook

Register a webhook endpoint to receive real-time notifications such as session completion or support messages. The target URL must be on a registered domain and payloads are signed with your secret key.

Request Body schema: application/json
required
endpoint
required
object (Endpoint)
secret_key
required
string (Secret Key)
Channel (string) or Channel (null) (Channel)
Default: null
Array of Filters (objects) or Filters (null) (Filters)
Default: null
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "channel": "default",
  • "create_timestamp": null,
  • "endpoint": {},
  • "filters": [
    ],
  • "webhook_owner": null,
  • "webhook_uuid": "cff3fe0e-122a-4cb6-8b73-465c529d8b02"
}

Search webhooks

List active webhook configurations owned by your organization. Use this to audit or manage existing callback endpoints.

Request Body schema: application/json
required
Limit (integer) or Limit (null) (Limit)
Default: 25
Cursor (string) or Cursor (null) (Cursor)
Default: null
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "cursor": null
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "item_count": 1,
  • "next_cursor": null
}

Get webhook

Retrieve details about a specific webhook, including its filters, channel, and current delivery status.

path Parameters
webhook_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "channel": "default",
  • "create_timestamp": null,
  • "endpoint": {},
  • "filters": [
    ],
  • "webhook_owner": null,
  • "webhook_uuid": "cff3fe0e-122a-4cb6-8b73-465c529d8b02"
}

Deactivate webhook

Disable a webhook so that no further events are delivered. The webhook remains in the system and can be reactivated or inspected later.

path Parameters
webhook_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}