Developers

PayQuality API reference

BYO Azure Functions API boundary linked from Azure Static Web Apps.

Version0.1.0
Operations13
Public6
Protected7
Machine-readable contractOpenAPI 3.1 JSON for clients, validation, and tooling.Developer homeEnvironment links, auth notes, and support context.Health checkNo-store system health response for the API boundary.

Operations

GET/api/healthPublic

Read API health

Returns a no-store health response with environment context.

Operation
getHealth
Responses
200
Tags
system
GET/api/openapi.jsonPublic

Read OpenAPI document

Returns the source-owned OpenAPI contract for this API.

Operation
getOpenApiDocument
Responses
200
Tags
system
GET/api/docsPublic

Read API reference

Returns a human-readable HTML reference generated from the source-owned OpenAPI contract.

Operation
getOpenApiDocs
Responses
200
Tags
system
GET/api/resourcesPublic

List Azure resources

Returns status-only Azure resource readiness metadata without raw resource names, tenant identifiers, endpoints, connection strings, or secrets.

Operation
listAzureResources
Responses
200
Tags
system
GET/api/meAuthenticated

Read current authenticated user

Resolves the SWA/CIAM principal into an active PayLens user account and active tenant memberships.

Operation
getCurrentUser
Responses
200, 401, 403
Tags
auth
POST/api/invitationsAuthenticated

Create tenant invitation

Allows an authorized tenant Owner, Admin, or PlatformAdmin to create a hashed-token invitation.

Operation
createInvitation
Responses
200, 403
Tags
auth
GET/api/invitations/{id}Public

Preview invitation

Returns non-sensitive invitation details before sign-in.

Operation
previewInvitation
Responses
200, 404
Tags
auth
PATCH/api/invitations/{id}Authenticated

Revoke invitation

Revokes a pending invitation by invitation id.

Operation
revokeInvitation
Responses
200, 403
Tags
auth
POST/api/invitations/{token}/acceptAuthenticated

Accept invitation

Links the authenticated identity to a PayLens user and activates tenant membership.

Operation
acceptInvitation
Responses
200, 403
Tags
auth
GET/api/tenants/{tenantId}/membershipsAuthenticated

List tenant memberships

Lists tenant memberships for an authorized tenant administrator or auditor.

Operation
listTenantMemberships
Responses
200, 403
Tags
auth
PATCH/api/tenants/{tenantId}/memberships/{membershipId}Authenticated

Update tenant membership

Changes a membership role or lifecycle status with audit capture.

Operation
updateTenantMembership
Responses
200, 403
Tags
auth
POST/api/registration/organization-requestsPublic

Submit organization registration request

Creates a pending public organization registration request with Terms acceptance.

Operation
submitOrganizationRegistrationRequest
Responses
200, 400
Tags
auth
PATCH/api/registration/organization-requests/{requestId}Authenticated

Review organization registration request

Approves or rejects a pending organization registration request and sends the requester Owner invitation email on approval.

Operation
reviewOrganizationRegistrationRequest
Responses
200, 403, 503
Tags
auth