{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:adatree-consent/consent-get-all-records":{"get":{"operationId":"security_adatree_consent_consent_get_all_records","summary":"Get Consents","description":"GET /consents","tags":["security"],"parameters":[{"name":"consumerId","in":"query","required":false,"description":"consumeId, please be kindly reminded of proper encoding as Id from some IDP could have special character like '|', which need be encoded…","schema":{"type":"string","description":"consumeId, please be kindly reminded of proper encoding as Id from some IDP could have special character like '|', which need be encoded…"},"example":"auth0%7c5fbc585628421a006e83d95d"},{"name":"consentId","in":"query","required":false,"description":"consent id","schema":{"type":"string","description":"consent id"}},{"name":"cdrArrangementId","in":"query","required":false,"description":"cdr arrangement id","schema":{"type":"string","description":"cdr arrangement id"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["REQUESTED","ACTIVE","REVOKED","EXPIRED"]},"example":"ACTIVE"},{"name":"accessFrequency","in":"query","required":false,"schema":{"type":"string","enum":["ONCE_OFF","ONGOING"]},"example":"ONCE_OFF"},{"name":"postUsageAction","in":"query","required":false,"schema":{"type":"string","enum":["DELETION","DE_IDENTIFICATION"]},"example":"DELETION"},{"name":"directMarketingAllowed","in":"query","required":false,"schema":{"type":"boolean"},"example":false},{"name":"useCases","in":"query","required":false,"description":"UseCase ids","schema":{"type":"array","description":"UseCase ids"}},{"name":"dataHolderBrandId","in":"query","required":false,"schema":{"type":"string"},"example":"55b3299a-3e50-48a2-a190-cca263ccaba5"},{"name":"oldestCreated","in":"query","required":false,"description":"Constrain the consent with created time at or after this date/time. If absent defaults to newestCreated minus 90 days. Format is aligned…","schema":{"type":"string","description":"Constrain the consent with created time at or after this date/time. If absent defaults to newestCreated minus 90 days. Format is aligned…"}},{"name":"newestCreated","in":"query","required":false,"description":"Constrain the consent with created time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString…","schema":{"type":"string","description":"Constrain the consent with created time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString…"}},{"name":"oldestRevoked","in":"query","required":false,"description":"Constrain the consent with revoked time at or after this date/time. If absent defaults to newestRevoked minus 90 days. Format is aligned…","schema":{"type":"string","description":"Constrain the consent with revoked time at or after this date/time. If absent defaults to newestRevoked minus 90 days. Format is aligned…"}},{"name":"newestRevoked","in":"query","required":false,"description":"Constrain the consent with revoked time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString…","schema":{"type":"string","description":"Constrain the consent with revoked time at or before this date/time. If absent defaults to today. Format is aligned to DateTimeString…"},"example":"1997-01-12T15:43:00.121Z"},{"name":"oldestSharingEndDate","in":"query","required":false,"description":"Constrain the consent with sharingEndDate time at or after this date/time. If absent defaults to newestSharingEndDate minus 90 days.…","schema":{"type":"string","description":"Constrain the consent with sharingEndDate time at or after this date/time. If absent defaults to newestSharingEndDate minus 90 days.…"},"example":"1997-01-12T15:43:00.121Z"},{"name":"newestSharingEndDate","in":"query","required":false,"description":"Constrain the consent with sharingEndDate time at or before this date/time. If absent defaults to today. Format is aligned to…","schema":{"type":"string","description":"Constrain the consent with sharingEndDate time at or before this date/time. If absent defaults to today. Format is aligned to…"}},{"name":"externalId","in":"query","required":false,"description":"Constrain the consent by externalId","schema":{"type":"string","description":"Constrain the consent by externalId"},"example":"an-external-id"}],"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":"byok"}},"/v1/security:adatree-consent/consent-record-create":{"post":{"operationId":"security_adatree_consent_consent_record_create","summary":"Create Consent","description":"POST /consents","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Adatree-Consumer-User-Agent":{"type":"string","description":"Mandatory for calls using a Machine token. The consumer's original User Agent header"},"Adatree-Consumer-Ip-Address":{"type":"string","description":"Mandatory for calls using a Machine token. The consumer's original IP address."},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/security:adatree-consent/consent-get-record":{"get":{"operationId":"security_adatree_consent_consent_get_record","summary":"Get Consent","description":"GET /consents/{consentId}","tags":["security"],"parameters":[{"name":"consentId","in":"query","required":true,"schema":{"type":"string"},"example":"148c9187-e52b-431f-9b24-7225e75ca2be"}],"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":"byok"}},"/v1/security:adatree-consent/consent-update-via-dashboard":{"post":{"operationId":"security_adatree_consent_consent_update_via_dashboard","summary":"Update a consent's via dashboard or back channel","description":"PATCH /consents/{consentId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consentId"],"properties":{"consentId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/security:adatree-consent/consent-revoke-record":{"post":{"operationId":"security_adatree_consent_consent_revoke_record","summary":"Revoke Consent","description":"DELETE /consents/{consentId}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consentId"],"properties":{"consentId":{"type":"string"}}}}}},"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":"byok"}},"/v1/security:adatree-consent/consent-authorization-redirect-url":{"get":{"operationId":"security_adatree_consent_consent_authorization_redirect_url","summary":"Get Authorization Redirect URL for a Consent","description":"GET /consents/{consentId}/authorization","tags":["security"],"parameters":[{"name":"consentId","in":"query","required":true,"schema":{"type":"string"},"example":"148c9187-e52b-431f-9b24-7225e75ca2be"},{"name":"state","in":"query","required":false,"description":"A state is generated by the consent user-agent (browser) and is used to bind the redirection response from a Data Holder with a user…","schema":{"type":"string","description":"A state is generated by the consent user-agent (browser) and is used to bind the redirection response from a Data Holder with a user…"}},{"name":"redirectUri","in":"query","required":false,"description":"The URI to redirect to from the data holder when the consumer has finished data holder authentication. Must be from the list of redirect…","schema":{"type":"string","description":"The URI to redirect to from the data holder when the consumer has finished data holder authentication. Must be from the list of redirect…"}}],"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":"byok"}},"/v1/security:adatree-consent/get-consent-events-list":{"get":{"operationId":"security_adatree_consent_get_consent_events_list","summary":"Retrieve consent events","description":"GET /consents/events","tags":["security"],"parameters":[{"name":"oldest","in":"query","required":false,"description":"Constrain the consent event result list with timestamp at or after this date/time. Format is aligned to DateTimeString common type","schema":{"type":"string","description":"Constrain the consent event result list with timestamp at or after this date/time. Format is aligned to DateTimeString common type"}},{"name":"newest","in":"query","required":false,"description":"Constrain the consent event result list with timestamp at or before this date/time. Format is aligned to DateTimeString common type","schema":{"type":"string","description":"Constrain the consent event result list with timestamp at or before this date/time. Format is aligned to DateTimeString common type"}},{"name":"consentId","in":"query","required":false,"description":"consent id","schema":{"type":"string","description":"consent id"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"page-size","in":"query","required":false,"description":"Page size to request. Default is 25 (standard pagination)","schema":{"type":"integer","default":25,"description":"Page size to request. Default is 25 (standard pagination)"}}],"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":"byok"}},"/v1/security:adatree-consent/data-holders-list-available":{"get":{"operationId":"security_adatree_consent_data_holders_list_available","summary":"Get Data Holders","description":"GET /software-products/{softwareProductId}/data-holders","tags":["security"],"parameters":[{"name":"softwareProductId","in":"query","required":true,"description":"The identifier of the software product registered at the ACCC registry. The list of data holders returned is the list where dynamic client…","schema":{"type":"string","description":"The identifier of the software product registered at the ACCC registry. The list of data holders returned is the list where dynamic client…"}}],"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":"byok"}},"/v1/security:adatree-consent/tokens-establish-data-access":{"post":{"operationId":"security_adatree_consent_tokens_establish_data_access","summary":"Create Tokens","description":"POST /tokens","tags":["security"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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":"byok"}},"/v1/security:adatree-consent/use-case-get-all":{"get":{"operationId":"security_adatree_consent_use_case_get_all","summary":"Get Use-cases","description":"GET /use-cases","tags":["security"],"parameters":[{"name":"combineScopes","in":"query","required":false,"description":"Combine scopes that can be combined according to the CDR Consumer Experience Standards","schema":{"type":"boolean","description":"Combine scopes that can be combined according to the CDR Consumer Experience Standards"},"example":true}],"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":"byok"}}},"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"}}}}}}}