{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:truora/report-behavior":{"post":{"operationId":"places_truora_report_behavior","summary":"Report Behavior","description":"POST /v1/behavior","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/list-checks":{"get":{"operationId":"places_truora_list_checks","summary":"List Checks","description":"GET /v1/checks","tags":["places"],"parameters":[{"name":"start_key","in":"query","required":false,"description":"Start key value for the pagination","schema":{"type":"string","description":"Start key value for the pagination"}},{"name":"report_id","in":"query","required":false,"description":"Report id checks to be returned","schema":{"type":"string","description":"Report id checks to be returned"}}],"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/places:truora/create-check":{"post":{"operationId":"places_truora_create_check","summary":"Create a background check","description":"POST /v1/checks","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Truora-Priority":{"type":"string","enum":["low","medium","high"],"description":"Describes the background check priority. The amount of high priority checks is limited by country. Medium priority is used by default"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/get-health-dashboard":{"get":{"operationId":"places_truora_get_health_dashboard","summary":"Get Health Dashboard","description":"GET /v1/checks/health","tags":["places"],"parameters":[{"name":"country","in":"query","required":false,"description":"Country in ISO 3166, uppercase","schema":{"type":"string","description":"Country in ISO 3166, uppercase"}},{"name":"unixTimestampSeconds","in":"query","required":false,"description":"Unix timestamp in seconds. Send a day timestamp to view the database hourly status for that day or send the current time to know the…","schema":{"type":"string","description":"Unix timestamp in seconds. Send a day timestamp to view the database hourly status for that day or send the current time to know the…"}},{"name":"unixtimezoneOffsetSeconds","in":"query","required":false,"description":"Offset between the local time and the UTC time in seconds. (e.g., Colombia is at UTC -18000 seconds)","schema":{"type":"string","description":"Offset between the local time and the UTC time in seconds. (e.g., Colombia is at UTC -18000 seconds)"}}],"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/places:truora/get-check":{"get":{"operationId":"places_truora_get_check","summary":"Get Background Check","description":"GET /v1/checks/{check_id}","tags":["places"],"parameters":[{"name":"check_id","in":"query","required":true,"description":"Check ID","schema":{"type":"string","description":"Check 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/places:truora/list-check-details":{"get":{"operationId":"places_truora_list_check_details","summary":"List Check Details","description":"GET /v1/checks/{check_id}/details","tags":["places"],"parameters":[{"name":"check_id","in":"query","required":true,"description":"ID of the Check","schema":{"type":"string","description":"ID of the Check"}},{"name":"start_key","in":"query","required":false,"description":"Start key value for the pagination","schema":{"type":"string","description":"Start key value for the pagination"}},{"name":"lang","in":"query","required":false,"description":"This parameter is used to specify the language wanted for details, if not specified details will come in their original language.","schema":{"type":"string","description":"This parameter is used to specify the language wanted for details, if not specified details will come in their original language."}}],"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/places:truora/get-pdf":{"get":{"operationId":"places_truora_get_pdf","summary":"Get PDF","description":"GET /v1/checks/{check_id}/pdf","tags":["places"],"parameters":[{"name":"lang","in":"query","required":false,"description":"Used to specify the language for the PDF, if not specified the PDF will be downloaded in Spanish.","schema":{"type":"string","description":"Used to specify the language for the PDF, if not specified the PDF will be downloaded in Spanish."}},{"name":"check_id","in":"query","required":true,"description":"ID of the check","schema":{"type":"string","description":"ID of the check"}}],"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/places:truora/create-pdf":{"post":{"operationId":"places_truora_create_pdf","summary":"Create PDF","description":"POST /v1/checks/{check_id}/pdf","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["check_id"],"properties":{"check_id":{"type":"string","description":"ID of the check"}}}}}},"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/places:truora/list-score-configs":{"get":{"operationId":"places_truora_list_score_configs","summary":"List Score Configurations","description":"GET /v1/config","tags":["places"],"parameters":[{"name":"start_key","in":"query","required":false,"description":"The key to start the pagination","schema":{"type":"string","description":"The key to start the 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/places:truora/create-score-config":{"post":{"operationId":"places_truora_create_score_config","summary":"Create Score Configurations","description":"POST /v1/config","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/update-custom-type":{"post":{"operationId":"places_truora_update_custom_type","summary":"Update Custom Type","description":"PUT /v1/config","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/delete-custom-type":{"post":{"operationId":"places_truora_delete_custom_type","summary":"Delete Custom Type","description":"DELETE /v1/config","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Name of the custom type to be deleted"},"country":{"type":"string","enum":["BR","CL","CO","CR","EC","MX","PE","ALL"],"description":"Country where the custom type is valid"}}}}}},"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/places:truora/list-continuous-checks":{"get":{"operationId":"places_truora_list_continuous_checks","summary":"Lists all continuous checks","description":"GET /v1/continuous-checks","tags":["places"],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:truora/create-continuous-check":{"post":{"operationId":"places_truora_create_continuous_check","summary":"Creates a continuous check that will run background checks recurrently according to the frequency provided.","description":"POST /v1/continuous-checks","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/get-continuous-check":{"get":{"operationId":"places_truora_get_continuous_check","summary":"Lists history associated with a Check. It can be paginated","description":"GET /v1/continuous-checks/{continuous_check_id}","tags":["places"],"parameters":[{"name":"continuous_check_id","in":"query","required":true,"description":"ID resulting from calling CreateContinuousCheck","schema":{"type":"number","description":"ID resulting from calling CreateContinuousCheck"}}],"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/places:truora/update-continuous-check":{"post":{"operationId":"places_truora_update_continuous_check","summary":"Updates a continuous check","description":"PUT /v1/continuous-checks/{continuous_check_id}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["continuous_check_id","body"],"properties":{"continuous_check_id":{"type":"number","description":"ID resulting from calling CreateContinuousCheck"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/get-v1-continuous-checks-continuous-check-id-history":{"get":{"operationId":"places_truora_get_v1_continuous_checks_continuous_check_id_history","summary":"Lists background check logs. It can be paginated","description":"GET /v1/continuous-checks/{continuous_check_id}/history","tags":["places"],"parameters":[{"name":"continuous_check_id","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/places:truora/list-hook":{"get":{"operationId":"places_truora_list_hook","summary":"Lists all hooks","description":"GET /v1/hooks","tags":["places"],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:truora/create-hook":{"post":{"operationId":"places_truora_create_hook","summary":"Creates a hook subscription","description":"POST /v1/hooks","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/update-hook":{"post":{"operationId":"places_truora_update_hook","summary":"Updates hook","description":"PUT /v1/hooks/{hook_id}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hook_id","body"],"properties":{"hook_id":{"type":"string","description":"Hook ID"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/delet-hook":{"post":{"operationId":"places_truora_delet_hook","summary":"Deletes hook","description":"DELETE /v1/hooks/{hook_id}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hook_id"],"properties":{"hook_id":{"type":"string","description":"Hook 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/places:truora/list-reports":{"get":{"operationId":"places_truora_list_reports","summary":"List Reports","description":"GET /v1/reports","tags":["places"],"parameters":[{"name":"start_key","in":"query","required":false,"description":"Start value for pagination.","schema":{"type":"string","description":"Start value for pagination."}},{"name":"username","in":"query","required":false,"description":"filter reports created by the specified username","schema":{"type":"string","description":"filter reports created by the specified username"}}],"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/places:truora/create-report":{"post":{"operationId":"places_truora_create_report","summary":"Create Report","description":"POST /v1/reports","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/places:truora/get-report":{"get":{"operationId":"places_truora_get_report","summary":"Get Report","description":"GET /v1/reports/{report_id}","tags":["places"],"parameters":[{"name":"report_id","in":"query","required":true,"description":"The ID of the Report","schema":{"type":"string","description":"The ID of the Report"}}],"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/places:truora/batch-upload":{"post":{"operationId":"places_truora_batch_upload","summary":"Batch Upload","description":"POST /v1/reports/{report_id}/upload","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["report_id","body"],"properties":{"report_id":{"type":"string","description":"The ID of the Report"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}}},"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"}}}}}}}