Is an applicant an eligible member?

Asks whether an applicant, who need not be signed in, is an eligible member of the calling frontend's community, by member code and the facts they entered. Every call is a membership check in eligibility mode, written to the Studio's check log with the applicant's IP.

The answer is the status alone, never why: an unknown member code and a known one with other facts get the same status, headers and body. Too many failed checks for one member code, from one applicant network (an IPv4 address, or an IPv6 /64) or at one frontend are refused with 429.

Authentication

• frontendKey (HTTP bearer token, format ofk_<prefix>_<secret>): The frontend's frontend key, issued in the Studio on the frontend's page and shown once: Authorization: Bearer ofk_…. Up to two are active at a time, so a key can be rotated without downtime.

Parameters

Request body

JSON, at most 4 KB. Other fields are ignored.

Content type: application/json, required

Example: An applicant

{
  "memberCode": "108900",
  "firstName": "Jürgen",
  "lastName": "Weiß",
  "birthDate": "1962-07-07"
}

Responses

200

Checked. valid: an eligible member of the frontend's community. not_valid: not, for whatever reason. unavailable: a register could not answer; ask again later.

Content type: application/json

Example: An eligible member

{
  "status": "valid"
}

Example: Not an eligible member

{
  "status": "not_valid"
}

Example: A register could not answer

{
  "status": "unavailable"
}

400

A body that is not JSON or misses or breaks a field, or a missing or bad X-Applicant-IP. Which one is not said.

Content type: application/json

Example: An invalid request

{
  "error": "invalid_request"
}

401

No frontend key, or one that is malformed, unknown or revoked, or the key of a disconnected frontend. Every case gets the same answer.

Headers

Content type: application/json

Example: Not authenticated

{
  "error": "unauthenticated"
}

413

A body over 4 KB.

Content type: application/json

Example: Too large

{
  "error": "too_large"
}

429

Too many failed checks for this member code, from this applicant's network (the IPv4 address, or the /64 an IPv6 address is in) or at this frontend. No register was asked. There is no Retry-After.

Content type: application/json

Example: Rate limited

{
  "error": "rate_limited"
}

503

The Studio itself failed, not a register (that is a 200 with unavailable). Retry later; the key is fine.

Content type: application/json

Example: The Studio is unavailable

{
  "error": "unavailable"
}