Skip to main content
POST
/
api
/
platform
/
check
/
update-config
/
{user_id}
Update a user's check settings
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/check/update-config/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "logo_url": "https://cdn.example.com/branding/acme-logo.png",
  "signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png",
  "set_default_logo": false
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "logo": "https://assets.internal/check-logos/USERID/logo.png",
    "signature": "https://assets.internal/check-signatures/USERID/sign.png"
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

​
X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user whose check config is being updated.

Body

application/json
​
logo_url
string | null

Public HTTPS URL of the logo to use on checks. Ignored if set_default_logo is true.

Example:

"https://cdn.example.com/branding/acme-logo.png"

​
signature_url
string | null

Public HTTPS URL of the signature image to use on checks.

Example:

"https://cdn.example.com/signatures/jane-doe-sign.png"

When true, clears the custom logo and uses the paywint logo.

Example:

false

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
ExternalCheckSettingsRead · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1765631850.663502

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400