API Reference

Update CompanySettings by companyId

post
https://api.embermind.ch/api/v1/client/company-settings/update

Update company settings including customer grouping rules, score thresholds and fingerprint configuration

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

If true, then customer grouping by external identifier is enabled.

string | null

Regular expression to check the validity of an external identifier

boolean

If true, then customer grouping by email is enabled.

string | null

Regular expression to check the validity of an email

boolean

If true, then customer grouping by phone is enabled.

string | null

Regular expression to check the validity of a phone

boolean

If true, then customer grouping by card token is enabled.

string | null

Regular expression to check the validity of a cardtoken

boolean

If true, then customer grouping by fingeprint is enabled.

string | null

Regular expression to check the validity of a fingerprint

boolean

If true, then customer grouping by IP-address is enabled.

string | null

Regular expression to check the validity of an IP-address

string
enum

Score generator priority one

Allowed:
string
enum

Score generator priority two

Allowed:
string
enum

Score generator priority three

Allowed:
number

Bad score border

string
enum

Fingerprint use type: CLIENT - use old fingerprint field, EXTERNAL - use fingerprintExternal

Allowed:
integer
≥ 0

How long to wait (ms) for fingerprintExternal to be populated before giving up (0 = no wait)

string
length ≤ 255

The capture endpoint this company embeds in the browser SDK (its domain option). Must be https. There is no platform-wide value: the capture host is first-party to each merchant. Empty string clears it.

boolean

EXTERNAL mode only: when the capture SDK has not delivered by the time scoring runs, score on the fingerprint sent in the request payload instead of scoring without one. Off by default — it changes which value customer grouping, black/white lists and the fingerprint score generators see.

integer
≥ 1

Threshold in minutes: a transaction staying in PENDING longer than this is shown as "Long pending" (default: 30)

integer
≥ 1

Empty traffic threshold (transactions): when the "High empty traffic" toggle is on, entities with a transaction count below this value are hidden for the selected period (default: 1)

boolean

Enable or disable auto buyer feature

boolean

Enable or disable all link detect status

boolean

Store transaction process auto-generated titles as externalId without _AUTO suffix

Headers
string
string
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?