Sign in

v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Platform Check

Update a user's check settings

Update the check settings for a specific user, including branding and preferences used when mailing checks.

This endpoint:

  • Requires platform API key authentication
  • Ensures the user_id belongs to the requesting platform
  • Updates settings such as check logo, signature, and related preferences
  • Supports resetting the logo to the system default
  • Returns the updated check settings in a standardized response
post/api/platform/check/update-config/{user_id}

Path parameters

user_idstring uuid required

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

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

Headers

X-Platform-IDstring uuid required

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

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

X-Signaturestring required

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

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

Request body

logo_urlstring nullable

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

signature_urlstring nullable

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

set_default_logoboolean

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

Example request

{
  "logo_url": "https://cdn.example.com/branding/acme-logo.png",
  "signature_url": "https://cdn.example.com/signatures/jane-doe-sign.png"
}

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

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

queryGeneratedTimenumber nullable

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

Example response

{
  "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
}