We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Search for a PEAX user

POST

https://proxy-stage.peax.ch/core-service-input-partner/agent-api/v1/partners/{partnerId}/user-lookup

Partners would like to match their user objects with the PEAX existing users. This API enables them to query user's by some predefined criteria (look at the API definition)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Example

{
    "firstName": "string",
    "lastName": "string",
    "street": "string",
    "streetNumber": "string",
    "postalCode": "string",
    "poBox": "string",
    "city": "string",
    "birthday": "2009-01-01",
    "peaxId": "string",
    "qualityLevel": "LOW"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://proxy-stage.peax.ch/core-service-input-partner/agent-api/v1/partners//user-lookup' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "string",
    "lastName": "string",
    "street": "string",
    "streetNumber": "string",
    "postalCode": "string",
    "poBox": "string",
    "city": "string",
    "birthday": "2009-01-01",
    "peaxId": "string",
    "qualityLevel": "LOW"
}'

Responses

🟢200There is(are) matching result(s)

application/json

Body

Example

[
    {
        "firstName": "string",
        "lastName": "string",
        "peaxId": "string"
    }
]

🟠400Bad request, given criteria combination is wrong

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

Modified at 2024-02-29 01:36:03

Changelog

Deliver object to PEAX