Skip to content

Custom API

Accreditation

Reference only. Not a decision unless cited in product/DECISIONS.md.

Accreditation

People apply for a role pass (Media, Industry, Artist, Sponsor). Staff approve or decline. Approve issues the same Live Pass the door already trusts. There is no checkout, no payment and no second QR.

Who this is for

Venue engineers and platforms that run press, industry or sponsor intake for a show or a whole festival, on their own site or through the AXYN hosted page.

Pick your surface

Headless first. Everything the hosted page does, you can do with the Partner API.

SurfaceUse it whenWhat you build
Headless APIYou want your own apply page, app or CRM hookCalls to /v1/accreditation/* (below)
Web SDKYou use React and want our form and status card on your pageAccreditationApplyForm + AccreditationStatusCard, opt-in
HostedYou just need a linkNothing. Share the apply link from organizer Setup

The hosted page on axyn.events is a client of the same public API. There is no private path.

How it works

  1. The organizer creates a class in Setup (or POST .../accreditation-classes) and binds a hidden ticket type. A show class binds a single-show type; a series class binds a series pass that admits every day.
  2. Each class has one apply link token (axyn_cls_…). Share it out of band: email, your press page, a partner newsletter. Rotate it if it leaks.
  3. The applicant submits. They get a reference (ACR-…) and a status token (axyn_clss_…).
  4. Staff approve, decline, waitlist or remove a pass. Approve issues exactly one Live Pass to the applicant email. Decline issues nothing.

Headless API

Public calls take no API key. The apply link is the credential to apply. The status token is the credential to read or withdraw.

# The form for a link: organizer, class, event or festival dates, questions.
curl https://api.axyn.events/v1/accreditation/apply/$APPLY_TOKEN

# Submit. Keep status_token; show reference_code to the applicant.
curl -X POST https://api.axyn.events/v1/accreditation/apply/$APPLY_TOKEN/applications \
  -H 'content-type: application/json' \
  -d '{"applicant_name":"Casey Rivera","applicant_email":"casey@example.com",
       "applicant_organization":"Napa Valley Register",
       "answers":[{"question_id":"$QUESTION_ID","answer_text":"napavalleyregister.com/casey"}]}'

# Status. Send the token as a header, never in a URL.
curl https://api.axyn.events/v1/accreditation/applications/$REFERENCE \
  -H "X-Accreditation-Status-Token: $STATUS_TOKEN"

# Withdraw while pending or waitlisted.
curl -X POST https://api.axyn.events/v1/accreditation/applications/$REFERENCE/withdraw \
  -H "X-Accreditation-Status-Token: $STATUS_TOKEN"

# Lost the link? Always 202. The link only goes to the address on file.
curl -X POST https://api.axyn.events/v1/accreditation/status-link \
  -H 'content-type: application/json' \
  -d '{"applicant_email":"casey@example.com","reference_code":"$REFERENCE"}'

A second submit by the same email while an application is open returns already_submitted with the same reference and no status token. The status link goes to that inbox, not to the caller.

Status is proof-gated. A wrong token, a wrong reference and a missing application are the same 404. Do not build a lookup by email alone.

Staff calls use a tenant API key or an organizer session, under /v1/events/{eventId}/accreditation… (one show) or /v1/productions/{productionId}/accreditation… (a series):

  • classes: list, create, update, delete (before anyone applies), rotate link
  • applications: list with search and cursor pages, detail, CSV export
  • decide: POST .../accreditation-applications/{id}/decision with approve, deny, waitlist or revoke, plus bulk POST .../decisions for up to 100

Removing a pass (revoke) needs a signed-in staff user, like any ticket void.

Capacity

Set max_approved on a class to cap approvals. Two staff approving the last place at once issue exactly one pass; the other gets class_capacity_reached. You can also bind a complimentary hold to fund the class from a comp pool.

Web SDK (opt-in)

import { AccreditationApplyForm, AccreditationStatusCard } from '@axyn/web-sdk';
import '@axyn/web-sdk/accreditation.css';

<AccreditationApplyForm
  api={api}
  applyToken={applyToken}
  statusHref={(reference, token) => `/press/status/${reference}#${token}`}
/>;

Mount these on their own page. They are separate exports; TicketPanel and CheckoutSpineRoot never include them.

What accreditation is not

ToolAnswersRuns when
AccreditationMay this person get this role pass?Apply, then staff approve
CouponHow much does this paid cart cost?Paid checkout only
Card partner (BIN)Is this payment card in the partner program?Paid checkout, before pay
GA hold allocationMay this audience buy from a reserved pool?A private buy link
  • Coupons cannot replace Accreditation approve. Do not use a coupon as a press code.
  • Approve has no card gate and no payment step in v1. No PaymentIntent, no BIN check, no coupon runs on approve.
  • Apply links are not coupon codes, seat access codes or allocation links, and those are refused as apply links.

Do not

  • Do not mount apply inside Get tickets, CheckoutSpineRoot or TicketPanel. General admission buyers never see accreditation.
  • Do not add a public Press link to event pages. Share the apply link out of band.
  • Do not put the status token in a URL query string or logs. Use a header, or a URL fragment your page reads and removes.
  • Do not issue a second QR. Approve issues the ordinary Live Pass.

Auth

Tenant API keys authorize only that tenant. Never send tenant_id from the browser as authority. Another tenant's class, link or application reads as not found.

Errors

CodeMeaning
accreditation_class_closedThe deadline passed. Open applications stay decidable.
accreditation_class_disabledThe organizer turned the class off.
already_submittedSame email already has an open application.
class_capacity_reachedThe class cap is reached. Decline or waitlist instead.
applicant_erasedThe applicant asked for erasure. Decline instead.
staff_user_requiredRemoving a pass needs a signed-in staff user.

See the full API list for every field.