Skip to content

Confirm a location's address with its sticker​

POST
/sticker/{code}/confirm

Someone on the team who works at the sticker's location confirms its address: the sticker was mailed there. Each sticker confirms once, and an address that is already confirmed answers 409.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

code*

The code printed in the sticker's QR (any case).

Type
string
Required
Example"K7Q2MX"

Responses​

Confirmed.

application/json
JSON
{
"confirmed": true,
"confirmedAt": "string",
"locationId": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress