Fetching Scoring Data for Users Using API

Expected workflow partner side

REST API for fetching scoring data for users

This API provides an endpoint to fetch the scoring data for a specified array of users.

Endpoint: POST https://api.x-faces.xyz/v1/scoring/result

Headers:

{
    "token": "uuid" // API-token of your project
}

Payload:

{
    "users": [
        "p-479141",
        "p-478823",
        // other users ids
    ]
}

users : array of partner’s ids of users for the project.

Authentication

You need to add a token header with the API-token value.

Response Wrapper

Server JSON responses are wrapped as follows:

{
    "result": bool,
    "message": string,
    "data": [
        {
            "user_external_id": "p-479141", // patrner's user id
            "model_name": "churn_model_v1",
            "model_type": "probability",
            "last_prediction": 0.04,
            "updated_at": "2025-08-14T11:46:19+00:00"
        },
        ...
    ]
}

result : whether the recognition of the bank card was launched successfully

message : optional message accompanying the result

data : array of dictionaries containing scoring results for each specified user

Possible result and message combinations

result : true - the payload was successfully processed.

result : false - an error occurred while processing the payload.

message : "Invalid token" - auth token passed in the headers is incorrect.

message : "Invalid payload provided" - endpoint received wrong payload.