Capability library / Application package

Zip package v1.0.0

Zip intake-to-procure API scaffold: read purchase requests, vendors and approvals — endpoint host and paths are unverified placeholders pending the gated official API reference.

Review state: In review · Not part of the reviewed release library

This page describes AAES Govern’s controls. AAES Operate has private-work permissions, operational reviews and recorded-spend limits; it does not include Govern. About AAES Govern

Before you enable this package

Draft package; not part of the reviewed library. Endpoints and credential requirements remain unverified. Confirm both before enabling capabilities.

Read each action's effects and exclusions below. Before installation, also read the complete package requirements, including credential issuance, scope, expiry, and provider permissions. These are deployment prerequisites, not capabilities this package supplies.

Capabilities (3)

Each capability below is one registered operation. The complete package JSON includes its exact network destination allowlist. The repository stores it at packs/zip.json and embeds a copy in the release binary.

Risk tiers. R0 is the minimum for reads. R2 is the minimum for write, create, update, execute, and invoke. R3 is the minimum for delete, send, pay, deploy, approve, share, and transfer. Operators can raise these levels. A minimum tier does not measure the operation's business or confidentiality risk.

Field guide. Endpoint is the service address and request method. Connector is the adapter that makes the call. Custody describes how the credential is held; the credential reference identifies the value to resolve. Data class sets handling requirements: pii means personal data, financial means financial records, and internal means internal organizational data.

zip.requests.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://zip-api-docs-gated.invalid/requests
Connector
http
Custody
customer_vault
Credential ref
secret-ref-zip-api-credential
Data class
financial

Read requests.

Query the purchase requests collection, classified as financial data. UNVERIFIED PATH: Zip's API reference is gated behind an authenticated session, and /requests appears only in third-party integrator documentation — verify the path, method and response shape against the gated official reference and substitute the real host before enabling. The registered path covers the collection read only; single-record reads are not registered.

zip.vendors.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://zip-api-docs-gated.invalid/vendors
Connector
http
Custody
customer_vault
Credential ref
secret-ref-zip-api-credential
Data class
pii

Read vendors.

Query the vendors collection: vendor master records, which carry named contacts and can identify individual persons, so the read is classified as pii (personal data) (a deployment whose policy classifies vendor master data differently may change it). UNVERIFIED PATH: Zip's API reference is gated behind an authenticated session, and /vendors appears only in third-party integrator documentation — verify the path, method and response shape against the gated official reference and substitute the real host before enabling.

The registered path covers the collection read only; single-record reads are not registered.

zip.approvals.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://zip-api-docs-gated.invalid/approvals
Connector
http
Custody
customer_vault
Credential ref
secret-ref-zip-api-credential
Data class
financial

Read approvals.

Query the approvals collection: approval objects on purchase requests, classified as financial data because approval objects sit on financial documents and carry approver identities. UNVERIFIED PATH: Zip's API reference is gated behind an authenticated session, and /approvals appears only in third-party integrator documentation — verify the path, method and response shape against the gated official reference and substitute the real host before enabling. The registered path covers the collection read only; single-record reads are not registered, and no approval action is registered by this pack.

Credential reference

The credential field names a reference rather than containing credential material. Packs are designed not to contain secrets; the format checks cover only known credential formats and cannot prove that arbitrary text contains no secrets. Installing a package registers its capabilities. Configure the provider credentials, endpoints, and network access, then test the integration in your environment before enabling it.

Reference
secret-ref-zip-api-credential
Custody
customer_vault
Injection
header (Authorization)

Configure the value and injection format specified in the package. Assign responsibility for credential rotation and revocation, restrict provider permissions, and keep credential material out of logs and responses.

Complete credential requirements

A Zip API credential, held in the client's own secret manager. The actual authentication scheme, issuance and renewal process, stored format, expiry, revocation path and available permission granularity are NOT established: Zip's API reference is gated behind an authenticated session, and the only official source available to this review is the ziphq.com integration-ecosystem marketing page, which describes per-API-key and per-OAuth-connection options with resource-, action- and user-role-level permissions but documents none of the underlying mechanics — do not read that page as establishing any of them.

The exact header format is likewise NOT verifiable from the official documentation available to this review (third-party integrator documentation describes an API key sent as Basic auth) — the stored material must be the complete Authorization header value (scheme included), and the scheme must be confirmed against the gated API reference before enabling. If the credential proves to be OAuth-based, an external token process must mint and refresh tokens and the client secret stays with that process; expiry and revocation behaviour is NOT established and must be confirmed against the gated reference — an expired or revoked value must fail closed.

Least privilege: grant the credential read permissions only, and only for the request, vendor and approval resources this pack registers — the ecosystem page's claim of resource- and action-level permissioning per key is unconfirmed against the reference, so a key that may write or approve anything this pack does not register is a finding.

Executor hygiene: the credential must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must never appear in crash reports; the executor's memory, log and crash handling are otherwise the deployment's review.

Resources

  • zip-requests (api, financial): https://zip-api-docs-gated.invalid/requests
  • zip-vendors (api, pii): https://zip-api-docs-gated.invalid/vendors
  • zip-approvals (api, financial): https://zip-api-docs-gated.invalid/approvals

Technical package and review record

Complete provider requirements and exclusions

Draft package: verify the provider contract before enabling. Zip's help center states that its API reference requires an authenticated Zip session and offers no public OpenAPI specification, Postman collection, or PDF export. On 2026-09-21 the reference returned 401 to unauthenticated requests and developers.ziphq.com was an empty template.

Official marketing material describes a REST API for reading, creating, and updating vendors, requests, invoices, and purchase orders, with API-key or OAuth connections and resource-, action-, and user-role permissions. It does not establish an authentication scheme, issuance, expiry, permission granularity, or operation contract.

The live api.ziphq.com host returned 401 even for nonexistent paths; those responses do not verify routes. The registered /requests, /vendors, and /approvals paths appear only in third-party integrator documentation. Their methods, parameters, and response shapes remain unverified.

A reviewer with Zip access must open the question-mark menu's API Documentation and verify every path, method, and payload. Replace zip-api-docs-gated.invalid and any incorrect paths in every endpoint, resource locator, and network allowlist together. The allowlists match exactly. The reserved .invalid host cannot resolve and does not identify a reviewed deployment destination.

All registrations are collection reads at R0. Every create, update, delete, and request-approval action is excluded; no approval endpoint has been verified. Also excluded: users, purchase orders, invoices, payments, agreements, audit logs, the Zip MCP server, and webhook subscriptions.

The package remains draft until gated-reference verification is complete. It has not been certified by Zip. The dated help-center source https://docs.ziphq.com/api/v2/help_center/en-us/articles/49398321531675.json (retrieved 2026-09-21) supports the documentation-access restriction and lack of public exports only.

Re-review on 2026-10-29: the readable HTML help article https://docs.ziphq.com/hc/en-us/articles/49398321531675-How-to-Access-API-Documentation still requires an authenticated Zip session and says there is no public OpenAPI specification, full Postman collection or PDF export. The JSON article URL, developer hub and candidate API specification were inaccessible through the web reader. The ZipHQ GitHub organization lists a developer-quality tool, not an API contract. All three operation contracts and the credential mechanics remain unverified; keep this draft disabled.

Download the complete package JSON for exact network allowlists, credential requirements, exclusions, and setup notes. Read these requirements before installation.

The full documentation review record is supplied in the evaluation package. The evaluation package runs in your environment and comes only with the paid design partnership. This page reproduces the source links and review block; the full record is available for evaluation. Discuss a design partnership to inspect it before installation.

Review block

This section reproduces the review block recorded in the pack file. The evidence and approval record is separate: for a reviewed pack, it is in the evaluation materials and in the release binary's embedded assets.

Review in progress; record dated 2026-10-29

4 sources, retrieved 2026-09-21, 2026-10-29

Current documentation links are navigation aids. They do not change the package, its historical sources or its review date. Review dates describe a documentation review, not a live integration test. No package is provider-endorsed or yet tested against a live provider tenant.

Release identity

SHA-256 of the pack file bytes: 92b2230756876775dc772c72f4fcf4e867922cb945c3d3685a1067a1cb428e9b

Not part of the reviewed release library. Editing a package changes its release identity. A deployment plan checks its own file digests; it does not restore reviewed status or authenticate approval.