Skip to main content

AppSessionInfo

kindstringrequired

Possible values: [app_session]

guestSearch objectrequired
attestChallengestring

Present only for an ios_app guest session that has not passed App Attest while App Attest is on (same value on every call for the session). Pass it to Apple App Attest and prove with POST /auth/app-attest. Absent for attested sessions, web guests, accounts and when App Attest is off. Binding: clientDataHash = SHA-256 of the UTF-8 bytes of this string exactly as received (do not base64-decode it); the challenge is unpadded base64url.

Possible values: <= 64 characters

enabledbooleanrequired

Whether new guest starts are enabled; already accepted owned work remains readable when disabled.

limitintegerrequired

Configured starts allowed in this server session.

Possible values: >= 0

remainingintegerrequired

Available new starts in this server session; the server remains authoritative.

Possible values: >= 0

paymentStagePaymentStage (string)required

Stage at which payment is required (selection = at match selection, results = when viewing results)

Possible values: [selection, results]

captchaRequiredboolean

Advisory, web_guest only; absent means false. True when the next new start needs a reCAPTCHA token in X-F2S-Captcha; the server remains authoritative.

imageUploadPreparation object

Optional browser-side search image preparation policy. Absence disables preparation.

enabledbooleanrequired
Default value: false
maxSideintegerrequired

Possible values: >= 1

Default value: 2048
minBytesintegerrequired

Possible values: >= 0

Default value: 1048576
formatstringrequired

Possible values: [jpeg, webp]

Default value: jpeg
qualityintegerrequired

Possible values: >= 1 and <= 100

Default value: 90
maxOutputPercentintegerrequired

Possible values: >= 1 and <= 100

Default value: 50
AppSessionInfo
{
"kind": "app_session",
"guestSearch": {
"attestChallenge": "string",
"enabled": true,
"limit": 0,
"remaining": 0,
"paymentStage": "selection",
"captchaRequired": true
},
"imageUploadPreparation": {
"enabled": false,
"maxSide": 2048,
"minBytes": 1048576,
"format": "jpeg",
"quality": 90,
"maxOutputPercent": 50
}
}