API: Signup and verification

Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.

POST/api/v1/orgs

Create Organization (createOrganization)

IAM action: none (any signed-in caller)

Request body (JSON, OrganizationIn)

Field	Type	Description
`country` required	string
`name` required	string

Responses

201 Created (CreatedOrganizationOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of CreatedOrganizationOut

Field	Type	Description
`country`	string
`home_region`	string
`id`	string
`name`	string
`status`	string
`tier`	string
`trn`	string

GET/api/v1/orgs/{organization_id}/id-documents

List Id Documents (listIdDocuments)

IAM action: org:ListIdDocuments

Parameter	In	Type	Description
`organization_id` required	path	string

Responses

200 OK (array of IdDocumentOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

POST/api/v1/orgs/{organization_id}/id-documents

Submit Id Document (submitIdDocument)

IAM action: org:SubmitIdDocument

Parameter	In	Type	Description
`organization_id` required	path	string

Request body (JSON, IdDocumentIn)

Field	Type	Description
`content_base64` required	string
`content_type` required	"image/jpeg" \| "image/png" \| "application/pdf"
`country` required	string
`kind` required	"national_id" \| "passport" \| "alien_id" \| "driving_licence" \| "company_registration"

Responses

201 Created (IdDocumentOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of IdDocumentOut

Field	Type	Description
`content_type`	string
`country`	string
`id`	string
`kind`	string
`review_reason`	string
`reviewed_at`	string (date-time) (nullable)
`size_bytes`	integer
`state`	string
`submitted_at`	string (date-time)
`trn`	string

GET/api/v1/orgs/{organization_id}/verification

Get Verification (getVerification)

IAM action: org:GetVerification

Parameter	In	Type	Description
`organization_id` required	path	string

Responses

200 OK (VerificationOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of VerificationOut

Field	Type	Description
`id_verified`	boolean
`id_verified_at`	string (date-time) (nullable)
`limits`	TierLimitsOut
`next_step`	string
`organization_id`	string
`phone_masked`	string
`phone_verified`	boolean
`phone_verified_at`	string (date-time) (nullable)
`tier`	string

GET/api/v1/signup/config

Signup Config (signupConfig)

IAM action: none (public, no sign-in)

Responses

200 OK (SignupConfigOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SignupConfigOut

Field	Type	Description
`countries`	array of CountryOut
`signup_open`	boolean
`turnstile_site_key`	string