{"openapi":"3.1.0","info":{"title":"DropSnare backorder API","version":"1.2.0","description":"Registrar onboarding, exclusive backorders, customer access, device authorisation, releases, tag handovers and monthly settlement."},"servers":[{"url":"https:\/\/api.dropsnare.co.uk\/api\/v1"}],"paths":{"\/":{"get":{"operationId":"getService","summary":"API discovery","responses":{"200":{"description":"Version and documentation links"}}}},"\/health":{"get":{"operationId":"getHealth","summary":"Check service and database connectivity","responses":{"200":{"description":"Service is accepting requests"},"503":{"description":"Service unavailable"}}}},"\/registrar-directory\/{tag}":{"get":{"operationId":"verifyPublicRegistrarTag","summary":"Verify a public registrar tag against the current registry directory or RDAP","description":"Public listing is distinct from registrar control and EPP authorisation. No membership or contact details are returned.","security":[],"parameters":[{"in":"path","name":"tag","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9-]{0,63}$"}}],"responses":{"200":{"description":"Confirmed public registrar tag","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"tag":{"type":"string"},"listed":{"const":true}},"required":["tag","listed"]}},"required":["data"]}}}},"404":{"description":"Registrar tag unlisted or invalid path."},"429":{"description":"API request limit reached."},"503":{"description":"No current evidence. Observe Retry-After before retrying."}}}},"\/auth\/register":{"post":{"operationId":"registerAccount","tags":["Accounts"],"summary":"Register and start a restricted email-verification session","security":[],"description":"Email is normalised to lowercase. If mail delivery is unavailable, the account is created and verification_sent is false.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","format":"email","maxLength":254},"password":{"type":"string","format":"password","minLength":8,"maxLength":72,"writeOnly":true,"description":"At least 8 characters, at most 72 UTF-8 bytes. Null bytes are rejected."},"timezone":{"type":"string","example":"Europe\/London","description":"IANA time zone. API timestamps are UTC."},"nominet_tag":{"type":"string","maxLength":64,"description":"A tag in the current Nominet public registrar directory."}},"required":["name","email","password","nominet_tag"]}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountRegistration"}},"required":["data"]}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory has not been imported or its verification has expired."}}}},"\/auth\/login":{"post":{"operationId":"loginAccount","tags":["Accounts"],"summary":"Verify the password and start a restricted factor session","security":[],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":254},"password":{"type":"string","format":"password","writeOnly":true}},"required":["email","password"]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountLogin"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}},"description":"The returned bearer can complete the next authentication step. A verified email and authenticator proof are required before accessing the account."}},"\/auth\/logout":{"post":{"operationId":"logoutAccount","tags":["Accounts"],"summary":"Revoke the current bearer token","security":[{"bearerAuth":[]}],"description":"Accepts any valid bearer.","responses":{"204":{"description":"Success with no response body"},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account":{"get":{"operationId":"getAccount","tags":["Accounts"],"summary":"Read your account settings","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the account:read ability.","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountUser"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}},"patch":{"operationId":"updateAccount","tags":["Accounts"],"summary":"Update display settings and default registrant","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"timezone":{"type":"string","example":"Europe\/London","description":"IANA time zone. API timestamps are UTC."},"default_registrant_profile_id":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountUser"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/password":{"put":{"operationId":"changeAccountPassword","tags":["Accounts"],"summary":"Change password and revoke existing credentials","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session. A successful response includes one new 24-hour session.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"current_password":{"type":"string","format":"password","writeOnly":true},"password":{"type":"string","format":"password","minLength":8,"maxLength":72,"writeOnly":true,"description":"At least 8 characters, at most 72 UTF-8 bytes. Null bytes are rejected."}},"required":["current_password","password"]}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountCredentials"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/verify-email":{"post":{"operationId":"sendVerification","tags":["Accounts"],"summary":"Request a fresh email verification code","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","responses":{"202":{"description":"Request accepted","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"required":["data"]}}}},"204":{"description":"Already verified."},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"Account email delivery unavailable.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/auth\/verify-email":{"post":{"operationId":"verifyAccountEmail","tags":["Accounts"],"summary":"Verify account email using the emailed code","security":[],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":64,"maxLength":64,"writeOnly":true,"description":"Single-use email code, valid for 30 minutes for its intended action."}},"required":["token"]}}}},"responses":{"204":{"description":"Success with no response body"},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/auth\/forgot-password":{"post":{"operationId":"forgotAccountPassword","tags":["Accounts"],"summary":"Request a password reset email","security":[],"description":"Same acknowledgement for known and unknown accounts when mail is configured.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":254}},"required":["email"]}}}},"responses":{"202":{"description":"Request accepted","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"required":["data"]}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"Account email delivery unavailable.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/auth\/reset-password":{"post":{"operationId":"resetAccountPassword","tags":["Accounts"],"summary":"Reset password using the emailed code","security":[],"description":"Revokes all sessions, integration keys and previous recovery codes.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":64,"maxLength":64,"writeOnly":true,"description":"Single-use email code, valid for 30 minutes for its intended action."},"password":{"type":"string","format":"password","minLength":8,"maxLength":72,"writeOnly":true,"description":"At least 8 characters, at most 72 UTF-8 bytes. Null bytes are rejected."}},"required":["token","password"]}}}},"responses":{"204":{"description":"Success with no response body"},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/email-change":{"post":{"operationId":"requestAccountEmailChange","tags":["Accounts"],"summary":"Request a new account email address","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":254},"current_password":{"type":"string","format":"password","writeOnly":true}},"required":["email","current_password"]}}}},"responses":{"202":{"description":"Request accepted","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"Account email delivery unavailable.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/auth\/confirm-email-change":{"post":{"operationId":"confirmAccountEmailChange","tags":["Accounts"],"summary":"Confirm the requested email address","security":[],"description":"Uses the code sent to the new email. Revokes existing credentials.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":64,"maxLength":64,"writeOnly":true,"description":"Single-use email code, valid for 30 minutes for its intended action."}},"required":["token"]}}}},"responses":{"204":{"description":"Success with no response body"},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/tokens":{"get":{"operationId":"listAccountTokens","tags":["Accounts"],"summary":"List active sessions and API keys","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":""},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"required":false,"description":""}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/AccountTokenInfo"}},"meta":{"type":"object","properties":{"page":{"type":"integer","minimum":1},"per_page":{"type":"integer","minimum":1,"maximum":100},"has_more":{"type":"boolean"}},"required":["page","per_page","has_more"]}},"required":["data","meta"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}},"post":{"operationId":"createAccountToken","tags":["Accounts"],"summary":"Issue a scoped API key","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":80},"abilities":{"type":"array","items":{"type":"string","enum":["account:read","registrants:read","registrants:write","orders:read","orders:write"]},"uniqueItems":true,"minItems":1,"maxItems":5},"expires_in_days":{"type":"integer","minimum":1,"maximum":365,"default":90},"customer_profile_id":{"type":["integer","null"],"minimum":1,"description":"Bind a customer key to one active registrant profile. Only orders:read and orders:write are available for a customer key."}},"required":["name","abilities"]}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/AccountCredentials"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/tokens\/{id}":{"delete":{"operationId":"revokeAccountToken","tags":["Accounts"],"summary":"Revoke a session or integration key","security":[{"bearerAuth":[]}],"description":"Requires a password-authenticated account session.","parameters":[{"name":"id","in":"path","schema":{"type":"integer","minimum":1},"required":true,"description":"Owner-scoped numeric resource ID."}],"responses":{"204":{"description":"Success with no response body"},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Resource does not belong to the account or does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/registrant-profiles":{"get":{"operationId":"listRegistrantProfiles","tags":["Registrant profiles"],"summary":"List your active registrant profiles","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the registrants:read ability.","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1},"required":false,"description":""},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"required":false,"description":""}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/RegistrantProfile"}},"meta":{"type":"object","properties":{"page":{"type":"integer","minimum":1},"per_page":{"type":"integer","minimum":1,"maximum":100},"has_more":{"type":"boolean"}},"required":["page","per_page","has_more"]}},"required":["data","meta"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}},"post":{"operationId":"createRegistrantProfile","tags":["Registrant profiles"],"summary":"Create a registrant profile","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the registrants:write ability.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RegistrantProfileInput"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/RegistrantProfile"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/registrant-profiles\/{id}":{"get":{"operationId":"getRegistrantProfile","tags":["Registrant profiles"],"summary":"Read a registrant profile","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the registrants:read ability.","parameters":[{"name":"id","in":"path","schema":{"type":"integer","minimum":1},"required":true,"description":"Owner-scoped numeric resource ID."}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/RegistrantProfile"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Resource does not belong to the account or does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}},"patch":{"operationId":"updateRegistrantProfile","tags":["Registrant profiles"],"summary":"Update a registrant profile","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the registrants:write ability.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RegistrantProfilePatch"}}}},"parameters":[{"name":"id","in":"path","schema":{"type":"integer","minimum":1},"required":true,"description":"Owner-scoped numeric resource ID."}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/RegistrantProfile"}},"required":["data"]}}}},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Resource does not belong to the account or does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Input validation failed, or the supplied code is invalid or expired.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}},"delete":{"operationId":"archiveRegistrantProfile","tags":["Registrant profiles"],"summary":"Archive a registrant profile","security":[{"bearerAuth":[]}],"description":"Requires a session or an API key with the registrants:write ability.","parameters":[{"name":"id","in":"path","schema":{"type":"integer","minimum":1},"required":true,"description":"Owner-scoped numeric resource ID."}],"responses":{"204":{"description":"Success with no response body"},"401":{"description":"Bearer token missing, revoked or expired, or invalid login credentials.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Bearer token lacks the required permission.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Resource does not belong to the account or does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Too many requests.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar":{"get":{"operationId":"readRegistrarSetup","tags":["Accounts"],"summary":"Read the signed-in member\u2019s setup and current eligibility","security":[{"bearerAuth":[]}],"description":"Requires a member account session. Integration and device tokens cannot manage registrar setup.","responses":{"200":{"description":"Current registrar setup","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"settings":{"type":["object","null"],"properties":{"default_tag":{"type":["string","null"],"maxLength":64},"default_contact":{"type":["string","null"],"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"},"epp_connections":{"type":"integer","minimum":3,"maximum":2147483647},"daily_creates":{"type":"integer","minimum":100,"maximum":2147483647},"onboarding_completed_at":{"type":["string","null"],"description":"UTC database timestamp"}},"required":["default_tag","default_contact","epp_connections","daily_creates","onboarding_completed_at"]},"status":{"type":"object","properties":{"installer_ready":{"type":"boolean","description":"The member has completed the website profile and can install a client before connecting to the registry."},"installer_blockers":{"type":"array","items":{"type":"string"}},"eligible":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}},"tag":{"type":["string","null"],"maxLength":64},"default_contact":{"type":["string","null"],"maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"},"epp_connections":{"type":"integer","minimum":0,"maximum":2147483647},"daily_creates":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["installer_ready","installer_blockers","eligible","reasons","tag","default_contact","epp_connections","daily_creates"]},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":64},"control_verified_at":{"type":["string","null"],"description":"UTC database timestamp"},"access_expires_at":{"type":["string","null"],"description":"UTC database timestamp"},"revoked_at":{"type":["string","null"],"description":"UTC database timestamp"},"review_requested_at":{"type":["string","null"],"description":"UTC database timestamp"}},"required":["tag","control_verified_at","access_expires_at","revoked_at","review_requested_at"]}}},"required":["settings","status","tags"]}},"required":["data"]}}}},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/tags":{"post":{"operationId":"addRegistrarTag","tags":["Accounts"],"summary":"Add a currently listed Nominet tag to the account","security":[{"bearerAuth":[]}],"description":"Requires a member account session. Integration and device tokens cannot manage registrar setup.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"nominet_tag":{"type":"string","maxLength":64}},"required":["nominet_tag"]}}}},"responses":{"204":{"description":"Saved"},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/settings":{"put":{"operationId":"updateRegistrarSettings","tags":["Accounts"],"summary":"Save the default tag, contact and shared allocations","security":[{"bearerAuth":[]}],"description":"Requires an account session. Submit contact after email verification to prepare a new default for the selected tag. Supply default_contact to use an existing registry handle. Both together are invalid. Omit both only to retain a previously saved default for the same tag. A new contact remains subject to independent registry confirmation.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"default_tag":{"type":"string","maxLength":64},"default_contact":{"type":"string","maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$","description":"Existing registry handle for integrations that already have one."},"epp_connections":{"type":"integer","minimum":3,"maximum":2147483647},"daily_creates":{"type":"integer","minimum":100,"maximum":2147483647},"contact":{"$ref":"#\/components\/schemas\/RegistrarContactInput"}},"required":["default_tag","epp_connections","daily_creates"],"not":{"required":["contact","default_contact"]}}}}},"responses":{"204":{"description":"Saved"},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/contact\/request":{"get":{"operationId":"downloadRegistrarContactRequest","tags":["Accounts"],"summary":"Download the current default contact creation request","security":[{"bearerAuth":[]}],"description":"Requires the owner\u2019s verified account session. Retrieve the XML using this endpoint and submit it via the registrar\u2019s authorised registry session. Downloading the file does not create or verify the contact at Nominet.","responses":{"200":{"description":"Current EPP contact creation request, containing private contact details.","headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"Attachment named nominet-contact.xml."}},"content":{"application\/xml":{"schema":{"type":"string"}}}},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"A verified member account session is required.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"No saved contact request matches this member, current tag and contact.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/verification":{"post":{"operationId":"requestRegistrarReview","tags":["Accounts"],"summary":"Submit a legacy registry case reference","deprecated":true,"security":[{"bearerAuth":[]}],"description":"Optional compatibility endpoint for older member integrations. Web onboarding, downloads and client pairing do not require a registry case.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"tag":{"type":"string","maxLength":64},"reference":{"type":"string","maxLength":64,"pattern":"^[A-Za-z0-9][A-Za-z0-9._\/-]{0,63}$"}},"required":["tag","reference"]}}}},"responses":{"204":{"description":"Saved"},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/pairings":{"post":{"operationId":"createClientPairing","tags":["Accounts"],"summary":"Issue a single-use, ten-minute pairing code for an installation-ready tag","security":[{"bearerAuth":[]}],"description":"Requires a member account session. Integration and device tokens cannot manage registrar setup.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"tag":{"type":"string","maxLength":64}},"required":["tag"]}}}},"responses":{"201":{"description":"Pairing code created","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"code":{"type":"string"},"expires_at":{"type":"string","format":"date-time"}},"required":["code","expires_at"]}},"required":["data"]}}}},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/account\/registrar\/devices\/{device}":{"delete":{"operationId":"revokeClientDevice","tags":["Accounts"],"summary":"Revoke a device belonging to the account","security":[{"bearerAuth":[]}],"description":"Requires a member account session. Integration and device tokens cannot manage registrar setup.","parameters":[{"name":"device","in":"path","required":true,"schema":{"type":"string","minLength":26,"maxLength":26}}],"responses":{"204":{"description":"Saved"},"401":{"description":"Invalid member token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"403":{"description":"Session or account permission required","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"404":{"description":"Member resource was not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"422":{"description":"Invalid submitted fields","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"429":{"description":"Rate limit reached","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}},"503":{"description":"The registrar directory is temporarily unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AccountApiError"}}}}}}},"\/auth\/two-factor\/setup":{"post":{"operationId":"prepareAccountAuthenticator","tags":["Accounts"],"summary":"Read the next factor step; generate the enrolment URI and manual key for this restricted session if needed","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Next step or completed session"},"401":{"description":"Expired session"},"403":{"description":"Email confirmation or fresh password required"},"422":{"description":"Code invalid or used"},"429":{"description":"Retry later"}}}},"\/auth\/two-factor\/confirm":{"post":{"operationId":"verifyAccountAuthenticator","tags":["Accounts"],"summary":"Verify an authenticator or recovery code; replace the restricted bearer with the returned bearer","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Next step or completed session"},"401":{"description":"Expired session"},"403":{"description":"Email confirmation or fresh password required"},"422":{"description":"Code invalid or used"},"429":{"description":"Retry later"}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["factor_code"],"properties":{"factor_code":{"type":"string","maxLength":40,"writeOnly":true},"recover":{"type":"boolean","default":false}}}}}}}},"\/drops-meta":{"get":{"tags":["Drop catalogue"],"security":[],"operationId":"dropPublication","summary":"Get latest verified drop list publication and freshness","responses":{"200":{"description":"Publication metadata; fields may be null before first import.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DropPublication"}},"required":["data"]}}}}}}},"\/drops":{"get":{"tags":["Drop catalogue"],"security":[],"operationId":"listDrops","summary":"List scheduled registry releases in time and domain order","parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["upcoming","confirmed","provisional","elapsed","all"],"default":"upcoming"},"description":"Filter by release status."},{"name":"date","in":"query","schema":{"type":"string","format":"date"},"description":"Exact UTC drop date."},{"name":"prefix","in":"query","schema":{"type":"string","maxLength":253},"description":"Literal, case-insensitive domain prefix."},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"description":"Rows per page."},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Use next_cursor with unchanged filters. Restart after snapshot_changed."}],"responses":{"200":{"description":"Calendar page.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/DropEntry"}},"meta":{"$ref":"#\/components\/schemas\/DropPublication"},"next_cursor":{"type":["string","null"]}},"required":["data","meta","next_cursor"]}}}},"409":{"description":"The source changed during pagination.","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"422":{"description":"Invalid cursor or filter.","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"503":{"description":"No verified list has been published.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/DropEntry"}},"meta":{"$ref":"#\/components\/schemas\/DropPublication"},"next_cursor":{"type":["string","null"]}},"required":["data","meta","next_cursor"]}}}}}}},"\/drops\/{domain}":{"get":{"tags":["Drop catalogue"],"security":[],"operationId":"lookupDrop","summary":"Look up a UK domain and whether it can currently be backordered here","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"},"description":"Exact .uk domain, case insensitive. A trailing dot is accepted."}],"responses":{"200":{"description":"Calendar state and local reservation availability.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DropLookup"},"meta":{"$ref":"#\/components\/schemas\/DropPublication"}},"required":["data","meta"]}}}},"422":{"description":"Invalid .uk name.","content":{"application\/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"]}}}},"503":{"description":"No verified list has been published.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DropLookup"},"meta":{"$ref":"#\/components\/schemas\/DropPublication"}},"required":["data","meta"]}}}}}}},"\/backorders":{"get":{"tags":["Backorders"],"operationId":"listBackorders","summary":"List your own reservations, newest first","description":"Requires the orders:read token scope.","security":[{"bearerAuth":[]}],"parameters":[{"in":"query","name":"cursor","schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","example":"01HWGH1E3SXPNFV810R1T6VYM4"},"description":"Use meta.next_cursor from the previous response."},{"in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}}],"responses":{"200":{"description":"Newest-first keyset pagination.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/OrderResource"}},"meta":{"type":"object","properties":{"next_cursor":{"type":["string","null"]}},"required":["next_cursor"]}},"required":["data","meta"]}}}},"401":{"description":"Invalid, missing or expired access token.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"403":{"description":"Token lacks the required scope.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"422":{"description":"Invalid cursor or limit.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"429":{"description":"Request rate limit reached.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}}}},"post":{"tags":["Backorders"],"operationId":"createBackorder","summary":"Reserve a confirmed release","description":"Requires the orders:write token scope.","security":[{"bearerAuth":[]}],"parameters":[{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._:-]+$"},"description":"One opaque key per intent per account. Reuse only for an exact retry."}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","example":"example.co.uk"},"registrant_profile_id":{"type":"integer","minimum":1,"description":"Owned profile. Omit to use your account default."},"release_id":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Optional guard against booking a later release of the same name."},"destination_tag":{"type":"string","maxLength":64,"description":"Receiving tag in the Nominet directory. Defaults to source_tag."},"source_tag":{"type":"string","maxLength":64,"description":"Eligible tag on your account. Defaults to the account default."},"sponsorship_id":{"type":"string","description":"Offer ID from the sponsoring tag. Requires release_id and max_cost_pence."},"max_cost_pence":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["domain"],"dependentRequired":{"sponsorship_id":["release_id","max_cost_pence"]}}}}},"responses":{"200":{"description":"Original creation receipt replayed. GET \/backorders\/{id} to read the current state.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OrderReceipt"}},"required":["data"]}}},"headers":{"Idempotency-Replayed":{"schema":{"type":"string","enum":["true","false"]}}}},"201":{"description":"The first successful reservation for the release.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OrderReceipt"}},"required":["data"]}}},"headers":{"Location":{"description":"Private canonical status URL for this order.","schema":{"type":"string"}},"Idempotency-Replayed":{"schema":{"type":"string","enum":["true","false"]}}}},"401":{"description":"Invalid, missing or expired access token.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"403":{"description":"Insufficient token scope, email verification or registrar eligibility.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"409":{"description":"Already reserved, idempotency key reused with different input, release changed, not bookable or account limit reached.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"422":{"description":"Invalid input, invalid Idempotency-Key, or no usable owned registrant profile.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"429":{"description":"Request rate limit reached.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"503":{"description":"No fresh verified calendar is available.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}}}}},"\/backorders\/{order}":{"parameters":[{"in":"path","name":"order","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","example":"01HWGH1E3SXPNFV810R1T6VYM4"}}],"get":{"tags":["Backorders"],"operationId":"getBackorder","summary":"Read the current state of your reservation","description":"Requires the orders:read token scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The owner's current reservation state.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OrderResource"}},"required":["data"]}}}},"401":{"description":"Invalid, missing or expired access token.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"403":{"description":"Token lacks the required scope.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"404":{"description":"Order missing or belongs to another account.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"429":{"description":"Request rate limit reached.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}}}}},"\/backorders\/{order}\/cancel":{"parameters":[{"in":"path","name":"order","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","example":"01HWGH1E3SXPNFV810R1T6VYM4"}}],"post":{"tags":["Backorders"],"operationId":"cancelBackorder","summary":"Cancel a reservation before its release","description":"Requires the orders:write token scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Cancellation receipt, including a repeated cancellation.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OrderResource"}},"required":["data"]}}}},"401":{"description":"Invalid, missing or expired access token.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"403":{"description":"Token lacks the required scope.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"404":{"description":"Order missing or belongs to another account.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"409":{"description":"Order is closed.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"429":{"description":"Request rate limit reached.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}},"503":{"description":"The current release cutoff cannot be verified.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderApiError"}}}}}}},"\/account\/sponsorships":{"get":{"operationId":"listSponsorships","summary":"List incoming and outgoing offers","tags":["Sponsorships"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Offers visible to the signed-in member","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/SponsorOffer"}},"meta":{"type":"object","properties":{"next_cursor":{"type":["string","null"]}}}}}}}},"401":{"description":"Valid registrar session required"},"403":{"description":"Registrar session scope required"}},"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string"}}]},"post":{"operationId":"offerSponsorship","summary":"Offer to sponsor one confirmed release","tags":["Sponsorships"],"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SponsorOffer"}},"required":["data"]}}}},"200":{"description":"Same offer already exists","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SponsorOffer"}},"required":["data"]}}}},"409":{"description":"Offer conflicts with a prior offer or catalogue entry"},"422":{"description":"Parties or terms are ineligible"},"401":{"description":"Valid registrar session required"},"403":{"description":"Registrar session scope required"}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SponsorOfferInput"}}}}}},"\/account\/sponsorships\/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"delete":{"operationId":"revokeSponsorship","summary":"Revoke an offer before a create permit is issued","tags":["Sponsorships"],"security":[{"bearerAuth":[]}],"responses":{"204":{"description":"Revoked"},"404":{"description":"Unknown or not issued by this member"},"409":{"description":"Permit already issued"},"401":{"description":"Valid registrar session required"},"403":{"description":"Registrar session scope required"}}}},"\/billing\/profile":{"get":{"summary":"Read invoice details and agreement","operationId":"getInvoiceProfile","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/InvoiceProfile"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"}}},"put":{"summary":"Save invoice details and accept agreement","operationId":"saveInvoiceProfile","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/InvoiceProfile"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"},"422":{"description":"Validation failed"}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SaveInvoiceProfile"}}}}}},"\/billing\/card":{"get":{"summary":"Read masked fallback card and consent agreement","operationId":"getFallbackCard","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SavedCardSummary"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"}}}},"\/billing\/card\/setups":{"post":{"summary":"Queue a hosted fallback card setup","operationId":"createCardSetup","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SetupReceipt"}},"required":["data"]}}},"headers":{"Location":{"description":"Member setup status path","schema":{"type":"string"}}}},"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SetupReceipt"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"},"409":{"description":"Invoice profile must be saved first"},"422":{"description":"Validation failed"}},"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RequestCardSetup"}}}}}},"\/billing\/card\/setups\/{reference}":{"get":{"summary":"Read the setup and private checkout URL","operationId":"getCardSetup","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SetupReceipt"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"},"404":{"description":"Resource not found for this account"}},"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"\/billing\/card\/{reference}":{"delete":{"summary":"Withdraw consent and request detachment","operationId":"withdrawFallbackCard","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/SetupReceipt"}},"required":["data"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"},"404":{"description":"Resource not found for this account"}},"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"\/billing\/card\/collections":{"get":{"summary":"List announced fallback collections","operationId":"listFallbackCollections","tags":["Member billing"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Member resource","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/FallbackCollection"}},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}]}},"required":["data","next_page"]}}}},"401":{"description":"Missing or invalid member session"},"403":{"description":"Session required"},"429":{"description":"Rate limit reached"},"422":{"description":"Validation failed"}},"parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000000}}]}},"\/account\/billing":{"get":{"operationId":"getMemberSettlementBalance","summary":"Read your balances and billing links","tags":["Monthly settlement"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated member response.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LedgerSummary"}},"required":["data"]}}}},"401":{"description":"A valid session bearer is required."},"403":{"description":"The account session or password is insufficient."},"429":{"description":"The request rate limit is exceeded."}}}},"\/account\/billing\/statements":{"get":{"operationId":"listMemberStatements","summary":"List your monthly statements","tags":["Monthly settlement"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated member response.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/LedgerStatement"}},"next_cursor":{"type":["integer","null"]}},"required":["data","next_cursor"]}}}},"401":{"description":"A valid session bearer is required."},"403":{"description":"The account session or password is insufficient."},"429":{"description":"The request rate limit is exceeded."},"422":{"description":"One or more fields are invalid."}},"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":1}}]}},"\/account\/billing\/statements\/{reference}":{"get":{"operationId":"getMemberStatement","summary":"Read your invoice and itemised costs","tags":["Monthly settlement"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated member response.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LedgerStatementDetail"}},"required":["data"]}}}},"401":{"description":"A valid session bearer is required."},"403":{"description":"The account session or password is insufficient."},"429":{"description":"The request rate limit is exceeded."},"422":{"description":"One or more fields are invalid."},"404":{"description":"No such statement for this account."}},"parameters":[{"name":"reference","in":"path","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":1}}]}},"\/account\/billing\/withdrawals":{"get":{"operationId":"listMemberWithdrawals","summary":"List your reimbursement requests","tags":["Monthly settlement"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated member response.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/LedgerWithdrawal"}},"next_cursor":{"type":["string","null"]}},"required":["data","next_cursor"]}}}},"401":{"description":"A valid session bearer is required."},"403":{"description":"The account session or password is insufficient."},"429":{"description":"The request rate limit is exceeded."},"422":{"description":"One or more fields are invalid."}},"parameters":[{"name":"before","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"requestCreditWithdrawal","summary":"Reserve cleared credit for a bank reimbursement","tags":["Monthly settlement"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated member response.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LedgerWithdrawalReceipt"}},"required":["data"]}}}},"401":{"description":"A valid session bearer is required."},"403":{"description":"The account session or password is insufficient."},"429":{"description":"The request rate limit is exceeded."},"201":{"description":"Withdrawal created and cleared funds reserved.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LedgerWithdrawalReceipt"}},"required":["data"]}}}},"409":{"description":"The idempotency key conflicts or the cleared balance is insufficient."},"422":{"description":"One or more fields are invalid."}},"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9:._-]{1,128}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/LedgerWithdrawalRequest"}}}}}},"\/client\/authorizations":{"post":{"operationId":"startClientAuthorization","tags":["Client protocol"],"summary":"Start a browser-approved PHP or Mac installation or connection","description":"The installer requests the current signed release. An installed client supplies its exact build and version in link mode. Display only the user code and fixed website address.","security":[],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/StartDeviceAuthorization"}}}},"responses":{"201":{"description":"A ten-minute private polling grant and the computer code to show the member.","content":{"application\/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/components\/schemas\/DeviceAuthorization"}}}}}},"410":{"description":"The installed client does not match the current signed release."},"422":{"description":"Invalid fields."},"429":{"description":"Too many requests. Observe Retry-After."},"503":{"description":"A compatible signed PHP release is unavailable."}}}},"\/client\/authorizations\/token":{"post":{"operationId":"pollClientAuthorization","tags":["Client protocol"],"summary":"Check the browser decision and redeem access","description":"Poll at the interval returned by the start request. An install grant permits a repeatable download ticket followed by one device exchange. A link grant permits one device exchange. Browser approval requires email verification, authenticator proof, a completed profile and explicit confirmation of the computer and registrar tag.","security":[],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PollDeviceAuthorization"}}}},"responses":{"200":{"description":"An installer ticket for this build or the one-time device credential.","content":{"application\/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/AuthorizedPhpDownload"},{"$ref":"#\/components\/schemas\/PairedDevice"}]}}}}}},"202":{"description":"Awaiting the member\u2019s decision.","content":{"application\/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","const":"pending"}}}}}}}},"403":{"description":"Declined, wrong phase, revoked approving session, or member no longer eligible."},"410":{"description":"Unknown, expired, superseded or already used. Start again."},"422":{"description":"Invalid fields."},"429":{"description":"Poll after Retry-After."},"503":{"description":"The signed release is unavailable."}}}},"\/client\/pair":{"post":{"operationId":"pairClientDevice","tags":["Client protocol"],"summary":"Exchange a one-use onboarding code","security":[],"responses":{"201":{"description":"Exchange a one-use onboarding code","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/PairedDevice"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"422":{"description":"Invalid or inconsistent fields."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"The code expires in ten minutes. The API rechecks installation eligibility for the selected tag at exchange. Save the returned 90-day device token immediately. Work requires a fresh connection report.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PairDevice"}}}}}},"\/client\/status":{"get":{"operationId":"getClientStatus","tags":["Client protocol"],"summary":"Read eligibility for the paired source tag","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Read eligibility for the paired source tag","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientStatus"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"429":{"description":"Rate limited. Observe Retry-After."}}}},"\/client\/heartbeat":{"post":{"operationId":"reportClientHeartbeat","tags":["Client protocol"],"summary":"Report observed connection, installed build, external usage and optional diagnostics","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Report observed connection, installed build, external usage and optional diagnostics","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientObservation"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"422":{"description":"Invalid or inconsistent fields."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"Report service-wide external usage for the registry account, excluding DropSnare usage. Omitting either counter makes this device ineligible for permits. Timing measurements are diagnostic only. For contact provisioning, send the environment, authenticated tag and server transaction ID of the successful EPP login together on each connected heartbeat. Only a fresh production session for this device\u2019s paired tag can retrieve or acknowledge its default contact.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientHeartbeat"}}}},"parameters":[{"name":"X-DropSnare-Lease","in":"header","required":false,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token. Required for connected reports or registry denials."}]}},"\/client\/work":{"get":{"operationId":"getClientWork","tags":["Client protocol"],"summary":"List eligible orders for this account and source tag","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"List eligible orders for this account and source tag","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientWork"}},"required":["data"]}}},"headers":{"ETag":{"schema":{"type":"string"}}}},"304":{"description":"Assignments, capacity and the runtime policy revision are unchanged."},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"426":{"description":"Install the required signed build."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"Returns up to 50 upcoming or recently released orders, current capacity and the runtime policy revision. Fetch \/client\/rules when the revision differs from the cached version. A list or lease provides no create permission.","parameters":[{"name":"If-None-Match","in":"header","schema":{"type":"string"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/orders\/{order}\/lease":{"post":{"operationId":"leaseClientOrder","tags":["Client protocol"],"summary":"Reserve an exclusive 60-second preview lease","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Reserve an exclusive 60-second preview lease","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientLease"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"426":{"description":"Install the required signed build."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"A current lease returns the same result when retried by its owning device.","parameters":[{"name":"order","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/leases\/{lease}\/permit":{"post":{"operationId":"issueClientPermit","tags":["Client protocol"],"summary":"Issue the single create permit for this release","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Issue the single create permit for this release","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientPermit"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"426":{"description":"Install the required signed build."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"A successfully issued permit is never returned again. Discard expired or ambiguous responses. Consult lease status after transport failure.","parameters":[{"name":"lease","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/leases\/{lease}":{"get":{"operationId":"getClientLease","tags":["Client protocol"],"summary":"Recover current state without issuing permission","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Recover current state without issuing permission","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientOutcome"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"404":{"description":"Resource unavailable in this device scope."},"429":{"description":"Rate limited. Observe Retry-After."}},"parameters":[{"name":"lease","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}}]}},"\/client\/leases\/{lease}\/result":{"put":{"operationId":"putClientResult","tags":["Client protocol"],"summary":"Record a device-reported registry result","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Record a device-reported registry result","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientOutcome"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"A caught result requires registry_reference. Identical retries are accepted. An unknown result may be replaced by a conclusive result or operator reconciliation.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientResult"}}}},"parameters":[{"name":"lease","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}}]}},"\/client\/handovers":{"get":{"operationId":"listClientHandovers","tags":["Client protocol"],"summary":"Read verified catches awaiting registrar handover","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Read verified catches awaiting registrar handover","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientHandoverList"}},"required":["data"]}}},"headers":{"ETag":{"schema":{"type":"string"}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"426":{"description":"Install the required signed build."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."},"304":{"description":"The handover page is unchanged."}},"description":"Review the preselected source and destination. The authenticated device cannot confirm completion. Check the zero-fee registrar channel and unchanged registrant before taking action.","parameters":[{"name":"after","in":"query","schema":{"type":"integer","minimum":1},"description":"Opaque continuation value returned by the preceding page."},{"name":"If-None-Match","in":"header","schema":{"type":"string"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/handovers\/{order}\/submission":{"put":{"operationId":"reportClientHandoverSubmission","tags":["Client protocol"],"summary":"Acknowledge an existing zero-fee submission for the same registrant","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Acknowledge an existing zero-fee submission for the same registrant","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientSubmissionReceipt"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"Send the exact order domain and both bound tags. The authenticated device that claimed this action can account for it after suspension or a service pause. Identical receipts are idempotent and preserve independently confirmed progress.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientSubmission"}}}},"parameters":[{"name":"order","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}}]}},"\/client\/handovers\/incoming":{"get":{"operationId":"listIncomingHandovers","tags":["Client protocol"],"summary":"List independently verified pending receiving-tag handshakes","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Read verified catches awaiting registrar handover","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientHandoverList"}},"required":["data"]}}},"headers":{"ETag":{"schema":{"type":"string"}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"426":{"description":"Install the required signed build."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."},"304":{"description":"The handover page is unchanged."}},"description":"Reserved for the verified receiving registrar. Check registry status and obtain the one-time claim before accepting.","parameters":[{"name":"after","in":"query","schema":{"type":"integer","minimum":1},"description":"Opaque continuation value returned by the preceding page."},{"name":"If-None-Match","in":"header","schema":{"type":"string"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/handovers\/{order}\/acceptance":{"put":{"operationId":"reportClientHandoverAcceptance","tags":["Client protocol"],"summary":"Record a receiving registrar acceptance receipt","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Acknowledge an existing zero-fee submission for the same registrant","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientSubmissionReceipt"}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"Claim the incoming action before acting. The claim holder can report its receipt after suspension or a service pause. Identical receipts are idempotent. Independent evidence finalises a transfer.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientSubmission"}}}},"parameters":[{"name":"order","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}}]}},"\/client\/handovers\/{order}\/claim":{"post":{"operationId":"claimClientHandover","tags":["Client protocol"],"summary":"Claim one pending release or receiving-tag acceptance","security":[{"deviceBearer":[]}],"responses":{"200":{"description":"Exclusive claim for this action","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"domain":{"type":"string"},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64},"state":{"type":"string","enum":["verification_pending","same_tag","pending_handover","submission_reported","awaiting_acceptance","completed","catch_unconfirmed","acceptance_reported"]},"registrant_change_allowed":{"type":"boolean","const":false},"maximum_fee_pence":{"type":"integer","const":0},"direction":{"type":"string","enum":["incoming","outgoing"]}},"required":["order_id","domain","source_tag","destination_tag","state","registrant_change_allowed","maximum_fee_pence","direction"]}},"required":["data"]}}}},"401":{"description":"Device token or pairing code is invalid, expired or revoked."},"403":{"description":"Registrar, evidence, billing or reporting device is ineligible."},"404":{"description":"Resource unavailable in this device scope."},"409":{"description":"Conflicting release, lease, capacity or prior result."},"422":{"description":"Invalid or inconsistent fields."},"503":{"description":"Dispatch paused or trusted catalogue, release or policy unavailable."},"429":{"description":"Rate limited. Observe Retry-After."}},"description":"One successful claim per direction. On a lost response or uncertain registry outcome, reconcile against the registry; do not submit another transfer.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"direction":{"type":"string","enum":["incoming","outgoing"]}},"required":["direction"]}}}},"parameters":[{"name":"order","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}},{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/registration-contact":{"get":{"operationId":"getClientRegistrationContact","tags":["Client protocol"],"summary":"Read the paired tag\u2019s default contact","security":[{"deviceBearer":[]}],"description":"Requires a current build and fresh matching production login. Reconcile an uncertain create using contact info and check the sponsoring tag and saved details.","responses":{"200":{"description":"Current contact provisioning state.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientRegistrationContact"}},"required":["data"]}}}},"401":{"description":"Invalid device."},"403":{"description":"Tag, account or registry access is unavailable."},"409":{"description":"A fresh production login for this tag is required, the contact has changed or the reported operation is unavailable."},"426":{"description":"Client update required."},"429":{"description":"Rate limited."},"503":{"description":"No client release is published."}},"parameters":[{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/registration-contact\/receipt":{"put":{"operationId":"reportClientRegistrationContact","tags":["Client protocol"],"summary":"Report registry confirmation of the saved contact","security":[{"deviceBearer":[]}],"description":"Use the registry server transaction reference for a successful contact create or confirmation through contact info. Repeats for the same current contact return its recorded state. A device report never grants registry permissions.","responses":{"200":{"description":"Current contact provisioning state.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientRegistrationContact"}},"required":["data"]}}}},"401":{"description":"Invalid device."},"403":{"description":"Tag, account or registry access is unavailable."},"409":{"description":"A fresh production login for this tag is required, the contact has changed or the reported operation is unavailable."},"426":{"description":"Client update required."},"429":{"description":"Rate limited."},"503":{"description":"No client release is published."},"422":{"description":"Invalid receipt fields."}},"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientContactReceipt"}}}},"parameters":[{"name":"X-DropSnare-Lease","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"},"description":"Current exclusive registry lease token."}]}},"\/client\/diagnostics\/summary":{"put":{"operationId":"putMacDiagnosticSummary","tags":["Client protocol"],"summary":"Record bounded hourly counters for the authenticated Mac","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MacDiagnosticSummary"}}}},"responses":{"200":{"description":"Accepted","content":{"application\/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["received","declined"]}},"required":["status"]}},"required":["data"]}}}},"401":{"description":"Missing, revoked or expired device token."},"403":{"description":"Unsupported platform."},"413":{"description":"Report exceeds the byte limit."},"415":{"description":"A JSON body is required."},"422":{"description":"Unknown fields, invalid types, values or time window."},"429":{"description":"Retry after the supplied delay."}}}},"\/client\/diagnostics\/requests\/{id}":{"put":{"operationId":"putMacDiagnosticReport","tags":["Client protocol"],"summary":"Answer a pending support request for this Mac","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MacDiagnosticUpload"}}}},"responses":{"200":{"description":"Accepted","content":{"application\/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["received","declined"]}},"required":["status"]}},"required":["data"]}}}},"401":{"description":"Missing, revoked or expired device token."},"403":{"description":"Unsupported platform."},"413":{"description":"Report exceeds the byte limit."},"415":{"description":"A JSON body is required."},"422":{"description":"Unknown fields, invalid types, values or time window."},"429":{"description":"Retry after the supplied delay."},"404":{"description":"The request does not belong to the current device."},"409":{"description":"Conflicts with the prior response."},"410":{"description":"The request expired."}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"\/client\/installers\/macos\/bootstrap":{"get":{"operationId":"getMacBootstrap","tags":["Client protocol"],"summary":"Retrieve the public Mac installer before comparing its SHA-256 to the value on Client downloads.","security":[],"responses":{"200":{"description":"Raw installer script","content":{"application\/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"503":{"description":"Installer unavailable."}}}},"\/client\/registry-lease":{"post":{"operationId":"pollRegistryLease","tags":["Client protocol"],"security":[{"deviceBearer":[]}],"summary":"Elect or renew one registry process for the account and tag","description":"A healthy holder retains its grant. A ready standby polls without opening any registry connection. On expiry the server waits for the drain deadline, then prefers a freshly present work-capable device and the newest ready check-in. ready=false marks the process unavailable.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["protocol","instance_id","ready"],"properties":{"protocol":{"type":"integer","enum":[1]},"instance_id":{"type":"string","format":"uuid"},"ready":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The token is present only for the holder. The lifetime starts at the beginning of the client request.","content":{"application\/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["role","lease_token","valid_for_seconds","retry_after_seconds"],"properties":{"role":{"type":"string","enum":["active","standby","unavailable"]},"lease_token":{"type":["string","null"],"pattern":"^[a-f0-9]{64}$"},"valid_for_seconds":{"type":"integer","enum":[0,45]},"retry_after_seconds":{"type":"integer","enum":[10]}}}}}}}},"401":{"description":"Invalid device token."},"422":{"description":"Invalid protocol, instance or readiness."},"503":{"description":"Release verification or API unavailable. Close registry sockets."}}}},"\/client\/updates":{"get":{"summary":"Check the current signed build for this device platform","tags":["Device updates"],"security":[{"deviceBearer":[]}],"parameters":[{"name":"If-None-Match","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Current representation","headers":{"ETag":{"schema":{"type":"string"}}},"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientUpdateStatus"}},"required":["data"],"additionalProperties":false}}}},"304":{"description":"Representation unchanged"},"401":{"description":"Device token invalid, expired or revoked"},"503":{"description":"Policy or trusted release unavailable"}}}},"\/client\/rules":{"get":{"summary":"Read current device polling intervals and work admission policy","tags":["Device updates"],"security":[{"deviceBearer":[]}],"parameters":[{"name":"If-None-Match","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Current representation","headers":{"ETag":{"schema":{"type":"string"}}},"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ClientRuntimePolicy"}},"required":["data"],"additionalProperties":false}}}},"304":{"description":"Representation unchanged"},"401":{"description":"Device token invalid, expired or revoked"},"503":{"description":"Policy or trusted release unavailable"}}}},"\/client\/updates\/{build}\/package":{"get":{"summary":"Download the current signed package for the paired platform","tags":["Device updates"],"security":[{"deviceBearer":[]}],"parameters":[{"name":"build","in":"path","required":true,"schema":{"type":"integer","minimum":1,"maximum":2147483647}}],"responses":{"200":{"description":"Verified publication bytes","content":{"application\/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Invalid device token"},"404":{"description":"Unpublished platform"},"410":{"description":"Build superseded"},"503":{"description":"Signed release or package unavailable"}}}},"\/account\/registrar\/devices":{"get":{"summary":"List paired devices and last update reports","operationId":"listMemberDevices","tags":["Device updates"],"security":[{"bearerAuth":[]}],"parameters":[{"in":"query","name":"after","schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"}}],"responses":{"200":{"description":"Up to 50 of your devices in ID order.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"name":{"type":"string"},"tag":{"type":"string"},"platform":{"type":"string","enum":["php","windows","macos","linux"]},"build":{"type":"integer","minimum":1,"maximum":2147483647},"version":{"type":"string"},"connected":{"type":"boolean"},"expires_at":{"type":"string","format":"date-time"},"last_seen_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"rtt_ms":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"clock_offset_ms":{"anyOf":[{"type":"integer"},{"type":"null"}]},"last_update":{"anyOf":[{"$ref":"#\/components\/schemas\/ClientInstallationReport"},{"type":"null"}]},"catch_role":{"type":"string","enum":["active","standby","offline","unavailable","update_required"],"description":"Exclusive registry device role; diagnostics-only installations can hold the registry lease without receiving work."}},"required":["id","name","tag","platform","build","version","connected","expires_at","last_seen_at","revoked_at","rtt_ms","clock_offset_ms","last_update","catch_role"]}},"next_after":{"anyOf":[{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},{"type":"null"}]}},"required":["data","next_after"]}}}},"401":{"description":"Missing, expired or revoked credentials."},"403":{"description":"Current account eligibility is insufficient."},"422":{"description":"Invalid input."},"429":{"description":"Rate limited."}}}},"\/account\/registrar\/installers":{"get":{"summary":"List platforms and get five-minute installer tickets","operationId":"listMemberInstallers","tags":["Device updates"],"security":[{"bearerAuth":[]}],"description":"Member session and a completed website profile required. A published build can be downloaded before the first registry connection and contact submission. An unpublished platform has a null build.","responses":{"200":{"description":"First-install media available on the API origin.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string","enum":["php","windows","macos","linux"]},"build":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}]},"manifest_url":{"type":"string"},"package_url":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"ticket":{"type":"string"},"version":{"type":"string","description":"Version from the verified PHP release manifest."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Checksum from the verified PHP release manifest."},"unavailable":{"type":"boolean","description":"The published PHP release could not be verified. Refresh later."}},"required":["platform","build"]}}},"required":["data"]}}}},"401":{"description":"Missing, expired or revoked credentials."},"403":{"description":"Current account eligibility is insufficient."},"422":{"description":"Invalid input."},"429":{"description":"Rate limited."}}}},"\/client\/installers\/{platform}\/{build}\/{resource}":{"post":{"summary":"Redeem a scoped first-install ticket on the API origin","operationId":"downloadMemberInstaller","tags":["Device updates"],"parameters":[{"in":"path","name":"platform","required":true,"schema":{"type":"string","enum":["php","windows","macos","linux"]}},{"in":"path","name":"build","required":true,"schema":{"type":"integer","minimum":1,"maximum":2147483647}},{"in":"path","name":"resource","required":true,"schema":{"type":"string","enum":["manifest","package"]}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"ticket":{"type":"string","maxLength":2048}},"required":["ticket"]}},"application\/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"ticket":{"type":"string","maxLength":2048}},"required":["ticket"]}}}},"responses":{"200":{"description":"Signed manifest or package bytes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SignedClientRelease"}},"application\/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Missing, expired or revoked credentials."},"403":{"description":"Current account eligibility is insufficient."},"422":{"description":"Invalid input."},"429":{"description":"Rate limited."},"404":{"description":"No release"},"410":{"description":"Superseded"},"503":{"description":"Untrusted release or missing package"}}}},"\/client\/updates\/{build}\/reports\/{attempt}":{"put":{"summary":"Record an install outcome for a single attempt","operationId":"recordDeviceUpdate","tags":["Device updates"],"security":[{"deviceBearer":[]}],"parameters":[{"in":"path","name":"build","required":true,"schema":{"type":"integer","minimum":1,"maximum":2147483647}},{"in":"path","name":"attempt","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"outcome":{"type":"string","enum":["installed","failed"]},"failure":{"type":"string","enum":["download_failed","signature_invalid","digest_mismatch","installation_failed","restart_failed","rollback"]}},"required":["outcome"],"allOf":[{"if":{"properties":{"outcome":{"const":"failed"}}},"then":{"required":["failure"]},"else":{"not":{"required":["failure"]}}}]}}}},"responses":{"200":{"description":"Durable device report.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/ClientInstallationReport"},{"type":"object","properties":{"attempt":{"type":"string","format":"uuid"}},"required":["attempt"]}]}},"required":["data"]}}}},"401":{"description":"Missing, expired or revoked credentials."},"403":{"description":"Current account eligibility is insufficient."},"422":{"description":"Invalid input."},"429":{"description":"Rate limited."},"409":{"description":"Conflicting replay or installed build not yet reported by heartbeat."},"404":{"description":"Release unknown on this platform."}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"},"deviceBearer":{"type":"http","scheme":"bearer","description":"The paired device token issued by DropSnare."}},"schemas":{"AccountUser":{"type":"object","properties":{"id":{"type":"integer","minimum":1},"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","format":"email","maxLength":254},"timezone":{"type":"string","example":"Europe\/London","description":"IANA time zone. API timestamps are UTC."},"default_registrant_profile_id":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"email_verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","email","timezone"]},"AccountTokenInfo":{"type":"object","properties":{"id":{"type":"integer","minimum":1},"name":{"type":"string","maxLength":80},"kind":{"type":"string","enum":["session","key","customer"]},"abilities":{"type":"array","items":{"type":"string","enum":["account:read","registrants:read","registrants:write","orders:read","orders:write"]},"uniqueItems":true,"minItems":1,"maxItems":5},"expires_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"customer_profile_id":{"type":["integer","null"],"minimum":1,"description":"Bind a customer key to one active registrant profile. Only orders:read and orders:write are available for a customer key."}},"required":["id","name","kind","abilities","expires_at","created_at"]},"AccountCredentials":{"type":"object","properties":{"access_token":{"type":"string","description":"Secret returned only at issue. Use in the HTTPS Authorization bearer header."},"token_type":{"type":"string","enum":["Bearer"]},"token":{"$ref":"#\/components\/schemas\/AccountTokenInfo"}},"required":["access_token","token_type","token"]},"AccountLogin":{"type":"object","properties":{"user":{"$ref":"#\/components\/schemas\/AccountUser"},"access_token":{"type":"string","description":"Secret returned only at issue. Use in the HTTPS Authorization bearer header."},"token_type":{"type":"string","enum":["Bearer"]},"token":{"$ref":"#\/components\/schemas\/AccountTokenInfo"}},"required":["user","access_token","token_type","token"]},"AccountRegistration":{"type":"object","properties":{"user":{"$ref":"#\/components\/schemas\/AccountUser"},"verification_sent":{"type":"boolean"},"access_token":{"type":"string","description":"Secret returned only at issue. Use in the HTTPS Authorization bearer header."},"token_type":{"type":"string","enum":["Bearer"]},"token":{"$ref":"#\/components\/schemas\/AccountTokenInfo"},"onboarding_url":{"type":"string","format":"uri"}},"required":["user","verification_sent","access_token","token_type","token"]},"RegistrantProfileInput":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"organisation":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"email":{"type":"string","format":"email","maxLength":254},"address_line1":{"type":"string","minLength":1,"maxLength":160},"address_line2":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":100},"region":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"postal_code":{"type":"string","minLength":1,"maxLength":24},"country_code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","example":"GB"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{5,14}$","example":"+441865555010"}},"required":["name","email","address_line1","city","postal_code","country_code","phone"]},"RegistrantProfilePatch":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"organisation":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"email":{"type":"string","format":"email","maxLength":254},"address_line1":{"type":"string","minLength":1,"maxLength":160},"address_line2":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":100},"region":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"postal_code":{"type":"string","minLength":1,"maxLength":24},"country_code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","example":"GB"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{5,14}$","example":"+441865555010"}}},"RegistrantProfile":{"type":"object","properties":{"id":{"type":"integer","minimum":1},"name":{"type":"string","minLength":1,"maxLength":120},"organisation":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"email":{"type":"string","format":"email","maxLength":254},"address_line1":{"type":"string","minLength":1,"maxLength":160},"address_line2":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":100},"region":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"postal_code":{"type":"string","minLength":1,"maxLength":24},"country_code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","example":"GB"},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{5,14}$","example":"+441865555010"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","email","address_line1","city","postal_code","country_code","phone"]},"AccountApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["error"]},"RegistrarContactInput":{"type":"object","description":"Contact details for the new default on the selected registrar tag. An individual supplies their own legal name. An organisation supplies both its legal name and a named administrative contact. The legal name must contain at least four characters and three letters.","properties":{"entity_type":{"type":"string","enum":["individual","organisation"]},"name":{"type":"string","description":"Individual legal name, or administrative contact name for an organisation.","maxLength":200},"organisation":{"type":"string","description":"Legal name when entity_type is organisation.","minLength":4,"maxLength":200},"email":{"type":"string","format":"email","maxLength":200},"address_line1":{"type":"string","description":"Building or street address with non-numeric information.","maxLength":255},"address_line2":{"type":["string","null"],"maxLength":255},"city":{"type":"string","maxLength":200},"region":{"type":["string","null"],"maxLength":200},"postal_code":{"type":["string","null"],"description":"Required for countries that use postcodes. UK codes accept compact or lowercase input and are stored in standard uppercase form.","maxLength":16},"country_code":{"type":"string","description":"Two-letter ISO 3166-1 country code.","minLength":2,"maxLength":2},"phone":{"type":["string","null"],"description":"Optional international telephone number with its country calling code.","examples":["+44 20 7946 0123"]}},"required":["entity_type","name","email","address_line1","city","country_code"],"if":{"properties":{"entity_type":{"const":"organisation"}}},"then":{"required":["organisation"]},"additionalProperties":false,"else":{"properties":{"name":{"minLength":4}}}},"DropPublication":{"type":"object","properties":{"snapshot_id":{"type":["integer","null"]},"source_published_at":{"type":["string","null"],"format":"date-time"},"imported_at":{"type":["string","null"],"format":"date-time"},"fresh_until":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"},"rows":{"type":"integer","minimum":0},"sha256":{"type":["string","null"]}},"required":["snapshot_id","source_published_at","imported_at","fresh_until","stale","rows","sha256"]},"DropEntry":{"type":"object","properties":{"domain":{"type":"string"},"release_id":{"type":["string","null"],"pattern":"^[a-f0-9]{64}$"},"drop_at":{"type":["string","null"],"format":"date-time"},"status":{"enum":["confirmed","provisional","elapsed","withdrawn","unlisted","catalogue_unavailable"]},"source_stale":{"type":"boolean"},"supported":{"type":"boolean"},"bookable":{"type":"boolean","description":"Eligible under the public calendar and service rules. An accepted order is the authoritative reservation."}},"required":["domain","release_id","drop_at","status","source_stale","supported","bookable"]},"DropLookup":{"type":"object","properties":{"domain":{"type":"string"},"release_id":{"type":["string","null"],"pattern":"^[a-f0-9]{64}$"},"drop_at":{"type":["string","null"],"format":"date-time"},"status":{"enum":["confirmed","provisional","elapsed","withdrawn","unlisted","catalogue_unavailable"]},"source_stale":{"type":"boolean"},"supported":{"type":"boolean"},"bookable":{"type":"boolean","description":"Eligible under the public calendar and service rules. An accepted order is the authoritative reservation."},"reserved_here":{"type":"boolean"},"available_for_backorder":{"type":"boolean"}},"required":["domain","release_id","drop_at","status","source_stale","supported","bookable","reserved_here","available_for_backorder"]},"OrderReceipt":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","example":"01HWGH1E3SXPNFV810R1T6VYM4"},"domain":{"type":"string","example":"example.co.uk"},"release_id":{"type":"string","pattern":"^[0-9a-f]{64}$"},"registrant_profile_id":{"type":"integer","minimum":1},"accepted_at":{"type":"string","format":"date-time"},"accepted_drop_at":{"type":"string","format":"date-time"},"sequence":{"type":"integer","minimum":1},"status":{"type":"string","const":"reserved"},"source_tag":{"type":["string","null"]},"destination_tag":{"type":["string","null"]},"source_contact":{"type":["string","null"]},"beneficiary_tag":{"type":["string","null"]},"sponsorship_id":{"type":["string","null"]},"max_cost_pence":{"type":["integer","null"]}},"required":["id","domain","release_id","registrant_profile_id","accepted_at","accepted_drop_at","sequence","status","source_tag","destination_tag","source_contact","beneficiary_tag","sponsorship_id","max_cost_pence"]},"OrderResource":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","example":"01HWGH1E3SXPNFV810R1T6VYM4"},"domain":{"type":"string","example":"example.co.uk"},"release_id":{"type":"string","pattern":"^[0-9a-f]{64}$"},"registrant_profile_id":{"type":"integer","minimum":1},"accepted_at":{"type":"string","format":"date-time"},"accepted_drop_at":{"type":"string","format":"date-time"},"sequence":{"type":"integer","minimum":1},"status":{"type":"string","enum":["reserved","provisional","cancelled","withdrawn","window_ended","catalogue_unavailable","unlisted","superseded"]},"drop_at":{"type":"string","format":"date-time"},"cancelled_at":{"type":["string","null"],"format":"date-time"},"can_cancel":{"type":"boolean"},"source_tag":{"type":["string","null"]},"destination_tag":{"type":["string","null"]},"source_contact":{"type":["string","null"]},"dispatch_status":{"type":["string","null"]},"handover_status":{"type":["string","null"]},"registry_verified_at":{"type":["string","null"],"format":"date-time"},"beneficiary_tag":{"type":["string","null"]},"sponsorship_id":{"type":["string","null"]},"max_cost_pence":{"type":["integer","null"]}},"required":["id","domain","release_id","registrant_profile_id","accepted_at","accepted_drop_at","sequence","status","drop_at","cancelled_at","can_cancel","source_tag","destination_tag","source_contact","dispatch_status","handover_status","registry_verified_at","beneficiary_tag","sponsorship_id","max_cost_pence"]},"OrderApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["error"]},"SponsorOfferInput":{"type":"object","properties":{"source_tag":{"type":"string","maxLength":64},"beneficiary_tag":{"type":"string","maxLength":64},"domain":{"type":"string","maxLength":254},"release_id":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"},"max_cost_pence":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["source_tag","beneficiary_tag","domain","release_id","max_cost_pence"]},"SponsorOffer":{"allOf":[{"$ref":"#\/components\/schemas\/SponsorOfferInput"},{"type":"object","properties":{"id":{"type":"string"},"currency":{"const":"GBP"},"created_at":{"type":"string","format":"date-time"},"revoked_at":{"type":["string","null"],"format":"date-time"}}}]},"InvoiceDetails":{"type":"object","properties":{"account_role":{"type":"string","enum":["registrar","customer"]},"payer_type":{"type":"string","enum":["individual","business"]},"legal_name":{"type":"string","maxLength":160},"billing_email":{"type":"string","format":"email","maxLength":254},"address_line1":{"type":"string","maxLength":160},"city":{"type":"string","maxLength":100},"country_code":{"type":"string","minLength":2,"maxLength":2},"postal_code":{"anyOf":[{"type":"string","maxLength":24},{"type":"null"}]},"nominet_tag":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"region":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"tax_reference":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"purchase_order":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]}},"required":[]},"SaveInvoiceProfile":{"type":"object","properties":{"account_role":{"type":"string","enum":["registrar","customer"]},"payer_type":{"type":"string","enum":["individual","business"]},"legal_name":{"type":"string","maxLength":160},"billing_email":{"type":"string","format":"email","maxLength":254},"address_line1":{"type":"string","maxLength":160},"city":{"type":"string","maxLength":100},"country_code":{"type":"string","minLength":2,"maxLength":2},"postal_code":{"anyOf":[{"type":"string","maxLength":24},{"type":"null"}]},"nominet_tag":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"address_line2":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"region":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"tax_reference":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"purchase_order":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"terms_version":{"type":"string"},"terms_accepted":{"type":"boolean","const":true}},"required":["account_role","payer_type","legal_name","billing_email","address_line1","city","country_code","terms_version","terms_accepted"]},"InvoiceProfile":{"type":"object","properties":{"details":{"anyOf":[{"$ref":"#\/components\/schemas\/InvoiceDetails"},{"type":"null"}]},"terms_version":{"type":"string"},"agreement":{"type":"string"},"accepted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"ready":{"type":"boolean"}},"required":["details","terms_version","agreement","accepted_at","ready"]},"StoredCard":{"type":"object","properties":{"reference":{"type":"string","format":"uuid"},"last4":{"type":"string"},"brand":{"type":"string"},"exp_month":{"type":"integer"},"exp_year":{"type":"integer"},"expired":{"type":"boolean"}},"required":["reference","last4","brand","exp_month","exp_year","expired"]},"SavedCardSummary":{"type":"object","properties":{"card":{"anyOf":[{"$ref":"#\/components\/schemas\/StoredCard"},{"type":"null"}]},"pending":{"type":"boolean"},"pending_reference":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"removal_pending":{"type":"boolean"},"terms_version":{"type":"string"},"agreement":{"type":"string"}},"required":["card","pending","pending_reference","removal_pending","terms_version","agreement"]},"SetupReceipt":{"type":"object","properties":{"reference":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["pending","active","cancelling","detaching","closed","expired"]},"checkout_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["reference","state","checkout_url"]},"RequestCardSetup":{"type":"object","properties":{"terms_version":{"type":"string"},"card_consent":{"type":"boolean","const":true}},"required":["terms_version","card_consent"]},"FallbackCollection":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"invoice_reference":{"type":"string"},"amount_pence":{"type":"integer"},"state":{"type":"string","enum":["notified","superseded","processing","paid","cancelled","declined","bank_payment_required"]},"collection_date":{"type":"string","format":"date"}},"required":["id","invoice_reference","amount_pence","state","collection_date"]},"LedgerSummary":{"type":"object","properties":{"currency":{"type":"string","const":"GBP"},"awaiting_bank_pence":{"type":"integer","minimum":0},"payable_pence":{"type":"integer","minimum":0},"receivable_pence":{"type":"integer","minimum":0},"withdrawable_pence":{"type":"integer","minimum":0},"withdrawal_pending_pence":{"type":"integer","minimum":0},"platform_fee_pence":{"type":"integer","minimum":0},"profile_path":{"type":"string"},"statements_path":{"type":"string"},"withdrawals_path":{"type":"string"}},"required":["currency","awaiting_bank_pence","payable_pence","receivable_pence","withdrawable_pence","withdrawal_pending_pence","platform_fee_pence","profile_path","statements_path","withdrawals_path"]},"LedgerStatement":{"type":"object","properties":{"reference":{"type":"string"},"month":{"type":"string","pattern":"^[0-9]{4}-(0[1-9]|1[0-2])$"},"currency":{"type":"string","const":"GBP"},"payment_state":{"type":"string","enum":["invoiced","statement","historical","awaiting_bank_instructions"]},"invoice_issued_at":{"type":["string","null"]},"issued_at":{"type":"string"},"due_at":{"type":["string","null"]},"own_cost_pence":{"type":["integer","null"]},"advanced_pence":{"type":["integer","null"]},"net_pence":{"type":"integer"},"payable_pence":{"type":"integer","minimum":0},"recorded_unsettled_pence":{"type":"integer","minimum":0},"settled_pence":{"type":"integer","minimum":0},"outstanding_pence":{"type":"integer","minimum":0},"cleared_pence":{"type":"integer","minimum":0},"platform_fee_pence":{"type":"integer","minimum":0}},"required":["reference","month","currency","payment_state","invoice_issued_at","issued_at","due_at","own_cost_pence","advanced_pence","net_pence","payable_pence","recorded_unsettled_pence","settled_pence","outstanding_pence","cleared_pence","platform_fee_pence"]},"LedgerLine":{"type":"object","properties":{"line_id":{"type":"integer","minimum":1},"kind":{"type":"string","description":"New charges are registration fees. Historical statements and their credit notes can also show create_usage.","enum":["registration","create_usage"]},"order_id":{"type":"string"},"domain":{"type":"string"},"charged_pence":{"type":"integer"},"advanced_pence":{"type":"integer"},"reverses_line_id":{"type":["integer","null"]},"posted_at":{"type":"string"}},"required":["line_id","kind","order_id","domain","charged_pence","advanced_pence","reverses_line_id","posted_at"]},"LedgerStatementDetail":{"allOf":[{"$ref":"#\/components\/schemas\/LedgerStatement"},{"type":"object","properties":{"invoice":{"oneOf":[{"type":"null"},{"type":"object","properties":{"billing_details":{"type":"object"},"supplier":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":["string","null"]}},"required":["name","address"]},"currency":{"type":"string","const":"GBP"},"fee_pence":{"type":"integer","minimum":0},"bank":{"oneOf":[{"type":"null"},{"type":"object","properties":{"payee":{"type":"string"},"sort_code":{"type":"string"},"account_number":{"type":"string"}},"required":["payee","sort_code","account_number"]}]}},"required":["billing_details","supplier","currency","fee_pence","bank"]}]},"lines":{"type":"array","items":{"$ref":"#\/components\/schemas\/LedgerLine"}},"next_line_cursor":{"type":["integer","null"]}},"required":["invoice","lines","next_line_cursor"]}]},"LedgerWithdrawal":{"type":"object","properties":{"id":{"type":"string"},"amount_pence":{"type":"integer","minimum":1},"state":{"type":"string","enum":["requested","prepared","paid","cancelled"]},"requested_at":{"type":"string"},"resolved_at":{"type":["string","null"]}},"required":["id","amount_pence","state","requested_at","resolved_at"]},"LedgerWithdrawalReceipt":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string"},"replayed":{"type":"boolean"}},"required":["id","state","replayed"]},"LedgerWithdrawalRequest":{"type":"object","properties":{"amount_pence":{"type":"integer","minimum":1,"maximum":999999999999},"payee":{"type":"string","maxLength":160},"sort_code":{"type":"string","pattern":"^[0-9]{2}[- ]?[0-9]{2}[- ]?[0-9]{2}$"},"account_number":{"type":"string","pattern":"^[0-9]{8}$"},"password":{"type":"string","format":"password","writeOnly":true}},"required":["amount_pence","payee","sort_code","account_number","password"]},"PairDevice":{"type":"object","properties":{"code":{"type":"string","pattern":"^pair_[a-f0-9]{48}$"},"name":{"type":"string","minLength":1,"maxLength":80},"platform":{"type":"string","enum":["php","windows","macos","linux"]},"version":{"type":"string","pattern":"^[0-9A-Za-z][0-9A-Za-z.+-]{0,31}$"},"build":{"type":"integer","minimum":1,"maximum":2147483647}},"required":["code","name","platform","version","build"]},"PairedDevice":{"type":"object","properties":{"observed_ip":{"description":"Public address observed on this API connection; null for a private or unavailable peer. A registry connection may use different egress.","anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"},{"type":"null"}]},"device_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"tag":{"type":"string","maxLength":64},"token_type":{"type":"string","enum":["Bearer"]},"access_token":{"type":"string","pattern":"^dev_[a-f0-9]{64}$"},"expires_at":{"type":"string","format":"date-time"}},"required":["device_id","tag","token_type","access_token","expires_at"]},"ClientEligibility":{"type":"object","properties":{"installer_ready":{"type":"boolean","description":"The account and selected tag meet website profile prerequisites for installing and pairing. Registry authorisation, contact confirmation and a fresh client connection are checked separately for registry work."},"installer_blockers":{"type":"array","items":{"type":"string"}},"eligible":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}},"tag":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"default_contact":{"anyOf":[{"type":"string"},{"type":"null"}]},"epp_connections":{"type":"integer","minimum":0},"daily_creates":{"type":"integer","minimum":0}},"required":["installer_ready","installer_blockers","eligible","reasons","tag","default_contact","epp_connections","daily_creates"]},"ClientStatus":{"type":"object","properties":{"observed_ip":{"description":"Public address observed on this API connection; null for a private or unavailable peer. A registry connection may use different egress.","anyOf":[{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"},{"type":"null"}]},"device_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"platform":{"type":"string","enum":["php","windows","macos","linux"]},"eligibility":{"$ref":"#\/components\/schemas\/ClientEligibility"},"rules":{"$ref":"#\/components\/schemas\/ClientRuntimePolicy"},"device_connected":{"type":"boolean"},"expires_at":{"type":"string","format":"date-time"}},"required":["device_id","platform","eligibility","rules"]},"ClientHeartbeat":{"type":"object","properties":{"connected":{"type":"boolean"},"active_connections":{"type":"integer","minimum":0,"maximum":65535},"build":{"type":"integer","minimum":1,"maximum":2147483647},"version":{"type":"string","pattern":"^[0-9A-Za-z][0-9A-Za-z.+-]{0,31}$"},"external_connections":{"anyOf":[{"type":"integer","minimum":0,"maximum":65535},{"type":"null"}]},"external_creates_24h":{"anyOf":[{"type":"integer","minimum":0,"maximum":2147483647},{"type":"null"}]},"rtt_ms":{"anyOf":[{"type":"integer","minimum":0,"maximum":60000},{"type":"null"}]},"clock_offset_ms":{"anyOf":[{"type":"integer","minimum":-86400000,"maximum":86400000},{"type":"null"}]},"registry_denial":{"anyOf":[{"type":"string","enum":["registry_blocked","create_denied"]},{"type":"null"}]},"external_tag_connections":{"anyOf":[{"type":"integer","minimum":0,"maximum":65535},{"type":"null"}]},"registry_environment":{"type":"string","enum":["production","testbed"]},"authenticated_tag":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9-]{0,63}$"},"login_reference":{"type":"string","pattern":"^[A-Za-z0-9_.:\/-]{1,100}$"}},"required":["connected","active_connections","version","build"],"dependentRequired":{"registry_environment":["authenticated_tag","login_reference"],"authenticated_tag":["registry_environment","login_reference"],"login_reference":["registry_environment","authenticated_tag"]}},"ClientObservation":{"type":"object","properties":{"observed_at":{"type":"string","format":"date-time"},"connection_report":{"type":"string","enum":["connected","disconnected"]},"evidence_source":{"type":"string","enum":["device_report"]},"fresh_for_seconds":{"type":"integer","minimum":1},"policy_revision":{"type":"integer","minimum":1},"latest_build":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}]},"update_required":{"type":"boolean"},"heartbeat_seconds":{"type":"integer","minimum":1},"diagnostic_request":{"oneOf":[{"$ref":"#\/components\/schemas\/ClientDiagnosticRequest"},{"type":"null"}],"description":"Included on macOS heartbeats. Null when support has not requested events."}},"required":["observed_at","connection_report","evidence_source","fresh_for_seconds","policy_revision","latest_build","update_required","heartbeat_seconds"]},"ClientBudget":{"type":"object","properties":{"available":{"type":"boolean"},"remaining_creates_24h":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"connection_allocation_ok":{"type":"boolean"},"external_usage_known":{"type":"boolean"}},"required":["available","remaining_creates_24h","connection_allocation_ok","external_usage_known"]},"ClientTarget":{"type":"object","properties":{"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"domain":{"type":"string"},"release_id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"release_at":{"type":"string","format":"date-time"},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64}},"required":["order_id","domain","release_id","release_at","source_tag","destination_tag"]},"ClientWork":{"type":"object","properties":{"assignments":{"type":"array","items":{"$ref":"#\/components\/schemas\/ClientTarget"}},"budget":{"$ref":"#\/components\/schemas\/ClientBudget"},"policy_revision":{"type":"integer","minimum":1},"poll_seconds":{"type":"integer","minimum":1}},"required":["assignments","budget","policy_revision","poll_seconds"]},"ClientLease":{"type":"object","properties":{"lease_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"state":{"type":"string","enum":["offered"]},"lease_until":{"type":"string","format":"date-time"},"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"domain":{"type":"string"},"release_id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"release_at":{"type":"string","format":"date-time"},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64}},"required":["lease_id","state","lease_until","order_id","domain","release_id","release_at","source_tag","destination_tag"]},"ClientPermit":{"type":"object","properties":{"lease_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"state":{"type":"string","enum":["permitted"]},"maximum_creates":{"type":"integer","const":1},"valid_until":{"type":"string","format":"date-time"},"registry_contact":{"type":"string"},"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"domain":{"type":"string"},"release_id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"release_at":{"type":"string","format":"date-time"},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64}},"required":["lease_id","state","maximum_creates","valid_until","registry_contact","order_id","domain","release_id","release_at","source_tag","destination_tag"]},"ClientResult":{"type":"object","properties":{"outcome":{"type":"string","enum":["caught","missed","unknown","not_sent"]},"registry_reference":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_.:\/-]{1,100}$"},{"type":"null"}]}},"required":["outcome"],"allOf":[{"if":{"properties":{"outcome":{"const":"caught"}}},"then":{"required":["registry_reference"],"properties":{"registry_reference":{"type":"string","pattern":"^[A-Za-z0-9_.:\/-]{1,100}$"}}}}]},"ClientOutcome":{"type":"object","properties":{"lease_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"state":{"type":"string","enum":["offered","permitted","unknown","caught","missed","not_sent"]},"permit_previously_issued":{"type":"boolean"},"registry_confirmed":{"type":"boolean"},"handover":{"anyOf":[{"type":"object","properties":{"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64},"state":{"type":"string","enum":["verification_pending","same_tag","pending_handover","submission_reported","awaiting_acceptance","completed","catch_unconfirmed","acceptance_reported"]}},"required":["source_tag","destination_tag","state"]},{"type":"null"}]}},"required":["lease_id","state","permit_previously_issued","registry_confirmed","handover"]},"ClientHandoverList":{"type":"object","properties":{"handovers":{"type":"array","items":{"type":"object","properties":{"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"domain":{"type":"string"},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64},"state":{"type":"string","enum":["verification_pending","same_tag","pending_handover","submission_reported","awaiting_acceptance","completed","catch_unconfirmed","acceptance_reported"]},"registrant_change_allowed":{"type":"boolean","const":false},"maximum_fee_pence":{"type":"integer","const":0},"recorded_at":{"type":"string","format":"date-time"},"claimed":{"type":"boolean"}},"required":["order_id","domain","source_tag","destination_tag","state","registrant_change_allowed","maximum_fee_pence","recorded_at"]}},"next_after":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]}},"required":["handovers","next_after"]},"ClientSubmission":{"type":"object","properties":{"domain":{"type":"string","maxLength":253},"source_tag":{"type":"string","maxLength":64},"destination_tag":{"type":"string","maxLength":64},"registry_reference":{"type":"string","pattern":"^[A-Za-z0-9_.:\/-]{1,100}$"},"zero_fee":{"type":"boolean","const":true},"registrant_unchanged":{"type":"boolean","const":true}},"required":["domain","source_tag","destination_tag","registry_reference","zero_fee","registrant_unchanged"]},"ClientSubmissionReceipt":{"type":"object","properties":{"order_id":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$"},"state":{"type":"string","enum":["verification_pending","same_tag","pending_handover","submission_reported","awaiting_acceptance","completed","catch_unconfirmed","acceptance_reported"]},"evidence_source":{"type":"string","enum":["device_report"]}},"required":["order_id","state","evidence_source"]},"ClientRegistrationContact":{"type":"object","properties":{"tag":{"type":"string"},"handle":{"type":"string"},"status":{"type":"string","enum":["create_or_confirm","reported","verified"]},"epp_request":{"type":["string","null"],"description":"EPP XML with the member\u2019s saved contact fields when provisioning is needed. A previously provisioned legacy handle can require a contact info lookup instead."}},"required":["tag","handle","status","epp_request"]},"ClientContactReceipt":{"type":"object","properties":{"tag":{"type":"string","maxLength":64},"handle":{"type":"string","maxLength":64},"operation":{"type":"string","enum":["created","confirmed_existing"]},"registry_reference":{"type":"string","pattern":"^[A-Za-z0-9_.:\/-]{1,100}$"}},"required":["tag","handle","operation","registry_reference"]},"StartDeviceAuthorization":{"type":"object","required":["mode","platform","name"],"properties":{"mode":{"type":"string","enum":["install","link"]},"name":{"type":"string","minLength":1,"maxLength":80},"platform":{"type":"string","enum":["php","macos"]},"build":{"type":"integer","minimum":1,"maximum":2147483647},"version":{"type":"string","pattern":"^[0-9A-Za-z][0-9A-Za-z.+-]{0,31}$"}},"allOf":[{"if":{"properties":{"mode":{"const":"link"}}},"then":{"required":["build","version"]}}]},"DeviceAuthorization":{"type":"object","required":["device_code","user_code","verification_uri","expires_in","interval"],"properties":{"device_code":{"type":"string","pattern":"^dsn_[0-9a-f]{64}$"},"user_code":{"type":"string","pattern":"^[A-HJ-NP-Z2-9]{4}-[A-HJ-NP-Z2-9]{4}$"},"verification_uri":{"type":"string","format":"uri","const":"https:\/\/dropsnare.co.uk\/connect-device"},"expires_in":{"type":"integer","const":600},"interval":{"type":"integer","const":5}}},"PollDeviceAuthorization":{"type":"object","required":["device_code","phase"],"properties":{"device_code":{"type":"string","pattern":"^dsn_[0-9a-f]{64}$"},"phase":{"type":"string","enum":["download","device"]}}},"AuthorizedPhpDownload":{"type":"object","required":["build","ticket"],"properties":{"build":{"type":"integer","minimum":3},"ticket":{"type":"string"}}},"ClientDiagnosticRequest":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid"},"since":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"max_records":{"const":512},"max_bytes":{"const":131072}},"required":["id","since","expires_at","max_records","max_bytes"]},"MacDiagnosticSummary":{"type":"object","additionalProperties":false,"properties":{"hour":{"type":"integer","multipleOf":3600,"description":"Unix timestamp of the UTC hour for these counters."},"build":{"type":"integer","minimum":1,"maximum":2147483647},"checkins":{"type":"integer","minimum":0,"maximum":2147483647},"errors":{"type":"integer","minimum":0,"maximum":2147483647},"registry_logins":{"type":"integer","minimum":0,"maximum":2147483647},"requests_seen":{"type":"integer","minimum":0,"maximum":2147483647},"create_attempts":{"type":"integer","minimum":0,"maximum":2147483647},"catches":{"type":"integer","minimum":0,"maximum":2147483647},"api_rtt_ms":{"type":"integer","minimum":0,"maximum":600000},"registry_rtt_ms":{"type":"integer","minimum":0,"maximum":600000},"transfer_confirmations":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["hour","build","checkins","errors","registry_logins","requests_seen","create_attempts","catches"]},"MacDiagnosticEvent":{"type":"object","additionalProperties":false,"properties":{"at":{"type":"integer","description":"UTC Unix seconds inside the requested interval."},"code":{"type":"string","enum":["worker_started","worker_stopped","link_approved","api_ok","api_failed","registry_connected","registry_disconnected","registry_denied","registry_error","contact_ready","contact_error","update_checked","update_installed","update_error","snoozed","resumed","clock_warning","storage_error","request_seen","create_attempt","catch_confirmed","transfer_confirmed","registry_rtt"]},"value":{"type":"integer","minimum":0,"maximum":600000}},"required":["at","code"],"allOf":[{"if":{"properties":{"code":{"const":"registry_rtt"}}},"then":{"required":["value"]}}]},"MacDiagnosticUpload":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"events":{"type":"array","maxItems":512,"items":{"$ref":"#\/components\/schemas\/MacDiagnosticEvent"}}},"required":["events"]},{"type":"object","additionalProperties":false,"properties":{"declined":{"const":true}},"required":["declined"]}]},"SignedClientRelease":{"type":"object","properties":{"key_id":{"type":"string","pattern":"^[a-f0-9]{64}$"},"payload":{"type":"string","contentEncoding":"base64"},"signature":{"type":"string","contentEncoding":"base64"}},"required":["key_id","payload","signature"],"additionalProperties":false},"ClientUpdateStatus":{"type":"object","properties":{"platform":{"type":"string","enum":["php","windows","macos","linux"]},"build":{"type":"integer","minimum":1,"maximum":2147483647},"latest_build":{"type":["integer","null"]},"minimum_build":{"type":"integer","minimum":0},"latest_version":{"type":["string","null"]},"update_available":{"type":"boolean"},"update_required":{"type":"boolean"},"release":{"oneOf":[{"$ref":"#\/components\/schemas\/SignedClientRelease"},{"type":"null"}]},"package_path":{"type":["string","null"]},"poll_seconds":{"type":"integer","minimum":10,"maximum":60}},"required":["platform","build","latest_build","latest_version","minimum_build","update_available","update_required","release","package_path","poll_seconds"],"additionalProperties":false},"ClientRuntimePolicy":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"maximum":2147483647},"work_enabled":{"type":"boolean"},"poll_seconds":{"type":"integer","minimum":10,"maximum":60},"heartbeat_seconds":{"type":"integer","minimum":15,"maximum":60},"lookahead_minutes":{"type":"integer","minimum":5,"maximum":1440},"late_seconds":{"type":"integer","minimum":5,"maximum":300}},"required":["revision","work_enabled","poll_seconds","heartbeat_seconds","lookahead_minutes","late_seconds"],"additionalProperties":false},"ClientInstallationReport":{"type":"object","properties":{"build":{"type":"integer","minimum":1,"maximum":2147483647},"outcome":{"type":"string","enum":["installed","failed"]},"failure":{"anyOf":[{"type":"string","enum":["download_failed","signature_invalid","digest_mismatch","installation_failed","restart_failed","rollback"]},{"type":"null"}]},"reported_at":{"type":"string","format":"date-time"}},"required":["build","outcome","failure","reported_at"]}}}}