Skip to main content
POST
Search Pep

Authorizations

X-API-Key
string
header
required

Body

application/json

Request model for PEP search operations.

This model defines the structure for PEP search API requests.

name
string
required

The name to search for in the PEP database

similarity_threshold
number
default:0.9

Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.

Required range: 0 <= x <= 1
limit
integer
default:1

The number of results to return. Max 50. Defaults to 1.

Required range: 1 <= x <= 50

Response

Successful Response

Response model for PEP search operations.

This model defines the structure for PEP search API responses.

total_matches
integer
required

The total number of PEP matches.

Examples:

1

2

3

matches
PEPMatch (v1) · object[]

The list of PEP matches.