{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:6-dot-authentiqio-appspot/key-register":{"post":{"operationId":"security_6_dot_authentiqio_appspot_key_register","summary":"Register a new ID `JWT(sub, devtoken)` v5: `JWT(sub, pk, devtoken, ...)` See:…","description":"POST /key","tags":["security"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/key-revoke-nosecret":{"post":{"operationId":"security_6_dot_authentiqio_appspot_key_revoke_nosecret","summary":"Revoke an Authentiq ID using email & phone. If called with `email` and `phone` only, a verification code…","description":"DELETE /key","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","phone"],"properties":{"email":{"type":"string","description":"primary email associated to Key (ID)"},"phone":{"type":"string","description":"primary phone number, international representation"},"code":{"type":"string","description":"verification code sent by email"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/key-retrieve":{"get":{"operationId":"security_6_dot_authentiqio_appspot_key_retrieve","summary":"Get public details of an Authentiq ID.","description":"GET /key/{PK}","tags":["security"],"parameters":[{"name":"PK","in":"query","required":true,"description":"Public Signing Key - Authentiq ID (43 chars)","schema":{"type":"string","description":"Public Signing Key - Authentiq ID (43 chars)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/key-update":{"post":{"operationId":"security_6_dot_authentiqio_appspot_key_update","summary":"update properties of an Authentiq ID. (not operational in v4; use PUT for now) v5: POST issuer-signed email…","description":"POST /key/{PK}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PK"],"properties":{"PK":{"type":"string","description":"Public Signing Key - Authentiq ID (43 chars)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/key-bind":{"post":{"operationId":"security_6_dot_authentiqio_appspot_key_bind","summary":"Update Authentiq ID by replacing the object. v4: `JWT(sub,email,phone)` to bind email/phone hash; v5: POST…","description":"PUT /key/{PK}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PK"],"properties":{"PK":{"type":"string","description":"Public Signing Key - Authentiq ID (43 chars)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/key-revoke":{"post":{"operationId":"security_6_dot_authentiqio_appspot_key_revoke","summary":"Revoke an Identity (Key) with a revocation secret","description":"DELETE /key/{PK}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PK","secret"],"properties":{"PK":{"type":"string","description":"Public Signing Key - Authentiq ID (43 chars)"},"secret":{"type":"string","description":"revokation secret"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/push-login-request":{"post":{"operationId":"security_6_dot_authentiqio_appspot_push_login_request","summary":"push sign-in request See: https://github.com/skion/authentiq/wiki/JWT-Examples","description":"POST /login","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["callback"],"properties":{"callback":{"type":"string","description":"URI App will connect to"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/sign-request":{"post":{"operationId":"security_6_dot_authentiqio_appspot_sign_request","summary":"scope verification request See: https://github.com/skion/authentiq/wiki/JWT-Examples","description":"POST /scope","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"test":{"type":"integer","description":"test only mode, using test issuer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/sign-retrieve":{"get":{"operationId":"security_6_dot_authentiqio_appspot_sign_retrieve","summary":"get the status / current content of a verification job","description":"GET /scope/{job}","tags":["security"],"parameters":[{"name":"job","in":"query","required":true,"description":"Job ID (20 chars)","schema":{"type":"string","description":"Job ID (20 chars)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/sign-confirm":{"post":{"operationId":"security_6_dot_authentiqio_appspot_sign_confirm","summary":"this is a scope confirmation","description":"POST /scope/{job}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job"],"properties":{"job":{"type":"string","description":"Job ID (20 chars)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/sign-update":{"post":{"operationId":"security_6_dot_authentiqio_appspot_sign_update","summary":"authority updates a JWT with its signature See: https://github.com/skion/authentiq/wiki/JWT-Examples","description":"PUT /scope/{job}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job"],"properties":{"job":{"type":"string","description":"Job ID (20 chars)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/security:6-dot-authentiqio-appspot/sign-delete":{"post":{"operationId":"security_6_dot_authentiqio_appspot_sign_delete","summary":"delete a verification job","description":"DELETE /scope/{job}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job"],"properties":{"job":{"type":"string","description":"Job ID (20 chars)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}