{"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/communication:callcontrol/complaints-complaints":{"get":{"operationId":"communication_callcontrol_complaints_complaints","summary":"Complaints: Free service (with registration), providing community and government complaint lookup by phone…","description":"GET /api/2015-11-01/Complaints/{phoneNumber}","tags":["communication"],"parameters":[{"name":"phoneNumber","in":"query","required":true,"description":"phone number to search","schema":{"type":"string","description":"phone number to search"}}],"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/communication:callcontrol/enterprise-api-get-user":{"get":{"operationId":"communication_callcontrol_enterprise_api_get_user","summary":"Enterprise GET: GetUser Returns the current information from the user; try 12066194123 as demo","description":"GET /api/2015-11-01/Enterprise/GetUser/{phoneNumber}","tags":["communication"],"parameters":[{"name":"phoneNumber","in":"query","required":true,"schema":{"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callcontrol/enterprise-api-should-block":{"get":{"operationId":"communication_callcontrol_enterprise_api_should_block","summary":"Enterprise GET: ShouldBlock Simple Enteprise which returns a call block proceed decision.","description":"GET /api/2015-11-01/Enterprise/ShouldBlock/{phoneNumber}/{userPhoneNumber}","tags":["communication"],"parameters":[{"name":"phoneNumber","in":"query","required":true,"description":"phone number to search","schema":{"type":"string","description":"phone number to search"}},{"name":"userPhoneNumber","in":"query","required":true,"description":"(OPTIONAL) phone number of user to look up block rules","schema":{"type":"string","description":"(OPTIONAL) phone number of user to look up block rules"}}],"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/communication:callcontrol/enterprise-api-upsert-user":{"post":{"operationId":"communication_callcontrol_enterprise_api_upsert_user","summary":"UpsertUser: insert or update all properties from a user PhoneNumber WhiteList (list of phone numbers to…","description":"POST /api/2015-11-01/Enterprise/UpsertUser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/communication:callcontrol/reputation-report":{"post":{"operationId":"communication_callcontrol_reputation_report","summary":"Report: report spam calls received to better tune our algorithms based upon spam calls you receive","description":"POST /api/2015-11-01/Report","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/communication:callcontrol/reputation-reputation":{"get":{"operationId":"communication_callcontrol_reputation_reputation","summary":"Reputation: Premium service which returns a reputation informaiton of a phone number via API.","description":"GET /api/2015-11-01/Reputation/{phoneNumber}","tags":["communication"],"parameters":[{"name":"phoneNumber","in":"query","required":true,"description":"phone number to search","schema":{"type":"string","description":"phone number to search"}}],"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"}}}}}}}