Skip to main content
POST
Send the terms value

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Path Parameters

id
string
required

The Child org id (UUID).

Body

application/json
terms_value
string
required

The tos_policies_value in terms_url, after your customer accepts the terms.

Minimum string length: 1

Response

The Child org, with its new status and requirements.

id
string<uuid>
required

The Child org id.

type
enum<string>
required
Available options:
individual,
business
display_name
string
required
reference
string | null
required
status
enum<string>
required

incomplete: requirements lists what you still owe before review. in_review: nothing is owed; the review is in progress. action_required: the review needs more from you; requirements lists it, and you send it with POST /v2/child-orgs/{id}/information. active: approved; the Child org can transact. requirements can list a request after approval; the status stays active. rejected: final; to try again, create a new Child org. suspended: the Child org or your organization is suspended.

Available options:
incomplete,
in_review,
action_required,
active,
rejected,
suspended
requirements
object[]
required
capabilities
object
required
associated_parties
object[]
required

A business’s associated parties, in the order you sent them. Name a party’s id when you upload its documents.

terms_url
string | null
required

The terms page to show your customer. After your customer accepts, send terms_value. Null after you send it.

created_at
string<date-time>
required