Hanzo AI

Get clearance

Reads one of the caller org's clearances, as it was decided.

GET /v1/principal/clearance/{id}

Addresshttps://api.hanzo.ai/v1/principal/clearance/{id}
MethodGET
Operationget_principal_clearance_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Reads one of the caller org's clearances, as it was decided. Any member of the paying org; another org's clearance is not found.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the clearance, "clr_"-prefixed.

Response

StatusBodyMeaning
200principal.Clearanceok
defaultproblem-detailsrefused

200 body — 58 fields.

FieldInTypeAlwaysDescription
allowedbodyboolean—
amountbodystring—Amount is the gross amount, U.S. dollars.
categorybodystring—Category is what is bought: services, attorney, rents, royalties, other or merchandise.
decidedAtbodyinteger (int64)—DecidedAt is when, unix seconds.
facts_requiredbodyprincipal.Fact[]—
facts_required[].blocksbodyboolean—Blocks is whether the payment waits on it.
facts_required[].codebodystring—Code is the fact's stable name.
facts_required[].questionbodystring—Question is what must be answered.
facts_required[].rulebodyprincipal.Rule—
facts_required[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
facts_required[].rule.reasonbodystring—Reason is the rule, stated.
idbodystring—ID is the clearance, "clr_"-prefixed.
noticebodystring—Notice is what a clearance is and is not.
payeebodystring—Payee is the org to be paid.
payerbodystring—Payer is the caller's org.
performedbodystring—Performed is where the service is performed, as stated.
platformbodyboolean—Platform is whether the caller operates the payee's platform, as stated.
railbodystring—Rail is how it moves.
reporting_obligationsbodyprincipal.Obligation[]—
reporting_obligations[].authoritybodystring—Authority is who it is filed with.
reporting_obligations[].codebodystring—Code is the obligation's stable name.
reporting_obligations[].duebodystring—Due is when.
reporting_obligations[].filerbodystring—Filer is the org that files it.
reporting_obligations[].formbodystring—Form is what is filed.
reporting_obligations[].jurisdictionbodystring—Jurisdiction is where, ISO 3166-1 alpha-2 or "EU".
reporting_obligations[].rulebodyprincipal.Rule—
reporting_obligations[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
reporting_obligations[].rule.reasonbodystring—Reason is the rule, stated.
reporting_obligations[].whenbodystring—When is the condition it is owed on, when it is owed on one.
required_before_paymentbodyprincipal.Step[]—
required_before_payment[].codebodystring—Code is the step's stable name, for a caller that branches on it.
required_before_payment[].rulebodyprincipal.Rule—
required_before_payment[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
required_before_payment[].rule.reasonbodystring—Reason is the rule, stated.
required_before_payment[].whatbodystring—What must happen, in words.
required_before_payment[].wherebodystring—Where it is done, when it is done on this platform.
required_before_payment[].whobodystring—Who does it: payer, payee, or "Hanzo platform reviewer".
rulesbodyprincipal.Decided[]—
rules[].fieldbodystring—
rules[].rulebodyprincipal.Rule—
rules[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
rules[].rule.reasonbodystring—Reason is the rule, stated.
settlement_methodsbodyprincipal.Method[]—
settlement_methods[].netbodystring—Net is what the payee receives, U.S. dollars.
settlement_methods[].railbodystring—Rail is the rail: ledger or chain.
settlement_methods[].rulebodyprincipal.Rule—
settlement_methods[].rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
settlement_methods[].rule.reasonbodystring—Reason is the rule, stated.
settlement_methods[].withheldbodystring—Withheld is what the payer keeps back and deposits itself, U.S. dollars.
statusbodystring—
withholdingbodyprincipal.Withholding—
withholding.amountbodystring—Amount is the amount to withhold, U.S. dollars; empty when the rate is.
withholding.chapterbodystring—Chapter is "3" (IRC chapter 3, a payment to a foreign person) or "backup" (IRC §3406), and empty when nothing is withheld or it cannot yet be decided.
withholding.ratebodystring—Rate is the rate in percent: "30", "24", "10", "0".
withholding.reasonbodystring—Reason says why, in words.
withholding.rulebodyprincipal.Rule—
withholding.rule.codebodystring—Code is the rule's stable name, for a caller that branches on it.
withholding.rule.reasonbodystring—Reason is the rule, stated.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Principal API · All Hanzo APIs · Interactive reference

How is this guide?

On this page