{"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:idtbeyond/get-iatu-balance":{"get":{"operationId":"communication_idtbeyond_get_iatu_balance","summary":"Account balance","description":"GET /iatu/balance","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}}],"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/communication:idtbeyond/get-iatu-charges-reports-all":{"get":{"operationId":"communication_idtbeyond_get_iatu_charges_reports_all","summary":"List of account charges in JSON","description":"GET /iatu/charges/reports/all","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"date_from","in":"query","required":true,"description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.777Z","description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}},{"name":"date_to","in":"query","required":true,"description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.777Z","description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}}],"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/communication:idtbeyond/get-iatu-charges-reports-all-csv":{"get":{"operationId":"communication_idtbeyond_get_iatu_charges_reports_all_csv","summary":"List of account charges in CSV","description":"GET /iatu/charges/reports/all.csv","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"date_from","in":"query","required":true,"description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.777Z","description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}},{"name":"date_to","in":"query","required":true,"description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.777Z","description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}}],"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/communication:idtbeyond/get-iatu-number-validator":{"get":{"operationId":"communication_idtbeyond_get_iatu_number_validator","summary":"Mobile number validation","description":"GET /iatu/number-validator","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"country_code","in":"query","required":true,"description":"2-digit code of the country in ISO 3166 format. 'BR'","schema":{"type":"string","default":"BR","description":"2-digit code of the country in ISO 3166 format. 'BR'"}},{"name":"mobile_number","in":"query","required":true,"description":"The mobile number you would like to validate. '5521983115555'","schema":{"type":"string","default":"5521983115555","description":"The mobile number you would like to validate. '5521983115555'"}}],"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/communication:idtbeyond/get-iatu-products-promotions":{"get":{"operationId":"communication_idtbeyond_get_iatu_products_promotions","summary":"Current promotions","description":"GET /iatu/products/promotions","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}}],"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/communication:idtbeyond/get-iatu-products-reports-all":{"get":{"operationId":"communication_idtbeyond_get_iatu_products_reports_all","summary":"Get a list of products in JSON format","description":"GET /iatu/products/reports/all","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}}],"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/communication:idtbeyond/get-iatu-products-reports-all-csv":{"get":{"operationId":"communication_idtbeyond_get_iatu_products_reports_all_csv","summary":"Get a list of products in CSV format","description":"GET /iatu/products/reports/all.csv","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}}],"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/communication:idtbeyond/get-iatu-products-reports-local-value":{"get":{"operationId":"communication_idtbeyond_get_iatu_products_reports_local_value","summary":"Get the estimated Local Value of a product","description":"GET /iatu/products/reports/local-value","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"country_code","in":"query","required":true,"description":"2-digit code of the country in ISO 3166 format. 'GT'","schema":{"type":"string","default":"GT","description":"2-digit code of the country in ISO 3166 format. 'GT'"}},{"name":"carrier_code","in":"query","required":true,"description":"Name of the mobile carrier. 'Claro'","schema":{"type":"string","default":"Claro","description":"Name of the mobile carrier. 'Claro'"}},{"name":"amount","in":"query","required":true,"description":"This is the amount, in cents, of the product you are purchasing. '500' = $5.00","schema":{"type":"integer","default":500,"description":"This is the amount, in cents, of the product you are purchasing. '500' = $5.00"}},{"name":"currency_code","in":"query","required":true,"description":"The currency code (ISO 4217) on the product you are querying. 'USD'","schema":{"type":"string","default":"USD","description":"The currency code (ISO 4217) on the product you are querying. 'USD'"}}],"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/communication:idtbeyond/post-iatu-topups":{"post":{"operationId":"communication_idtbeyond_post_iatu_topups","summary":"Topup a mobile phone","description":"POST /iatu/topups","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["x-idt-beyond-app-id","x-idt-beyond-app-key","body"],"properties":{"x-idt-beyond-app-id":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"},"x-idt-beyond-app-key":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"},"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":"live"}},"/v1/communication:idtbeyond/post-iatu-topups-reports":{"post":{"operationId":"communication_idtbeyond_post_iatu_topups_reports","summary":"Search topups transactions","description":"POST /iatu/topups/reports","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["x-idt-beyond-app-id","x-idt-beyond-app-key","body"],"properties":{"x-idt-beyond-app-id":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"},"x-idt-beyond-app-key":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"},"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":"live"}},"/v1/communication:idtbeyond/get-iatu-topups-reports-all":{"get":{"operationId":"communication_idtbeyond_get_iatu_topups_reports_all","summary":"List of account topups in JSON","description":"GET /iatu/topups/reports/all","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"date_from","in":"query","required":true,"description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}},{"name":"date_to","in":"query","required":true,"description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}}],"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/communication:idtbeyond/get-iatu-topups-reports-all-csv":{"get":{"operationId":"communication_idtbeyond_get_iatu_topups_reports_all_csv","summary":"List of account topups in CSV","description":"GET /iatu/topups/reports/all.csv","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"date_from","in":"query","required":true,"description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}},{"name":"date_to","in":"query","required":true,"description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}}],"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/communication:idtbeyond/get-iatu-topups-reports-totals":{"get":{"operationId":"communication_idtbeyond_get_iatu_topups_reports_totals","summary":"Summary of account topups in JSON","description":"GET /iatu/topups/reports/totals","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}},{"name":"date_from","in":"query","required":true,"description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}},{"name":"date_to","in":"query","required":true,"description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'","schema":{"type":"string","default":"2025-10-15T13:50:18.778Z","description":"The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'"}}],"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/communication:idtbeyond/post-iatu-topups-reverse":{"post":{"operationId":"communication_idtbeyond_post_iatu_topups_reverse","summary":"Reversal of a Topup","description":"POST /iatu/topups/reverse","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["x-idt-beyond-app-id","x-idt-beyond-app-key","body"],"properties":{"x-idt-beyond-app-id":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"},"x-idt-beyond-app-key":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"},"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":"live"}},"/v1/communication:idtbeyond/get-status":{"get":{"operationId":"communication_idtbeyond_get_status","summary":"Status check","description":"GET /status","tags":["communication"],"parameters":[{"name":"x-idt-beyond-app-id","in":"query","required":true,"description":"Application ID you would like to use","schema":{"type":"string","default":"APP_ID","description":"Application ID you would like to use"}},{"name":"x-idt-beyond-app-key","in":"query","required":true,"description":"Application KEY you would like to use","schema":{"type":"string","default":"APP_KEY","description":"Application KEY you would like to use"}}],"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"}}},"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"}}}}}}}