Get customer service-balance caregiver account disclosure readiness

GET

/customer-service-balance-caregiver-account-disclosure-readiness/{reservationBookingId}

const url = 'https://example.com/customer-service-balance-caregiver-account-disclosure-readiness/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/customer-service-balance-caregiver-account-disclosure-readiness/example \
  --header 'Authorization: Bearer <token>'

Authorizations

supabaseBearerAuth

Parameters

Path Parameters

reservationBookingId

required

string

>= 1 characters

Responses

200

Backend-owned readiness projection for customer-visible caregiver account disclosure

application/json

CustomerServiceBalanceCaregiverAccountDisclosureReadinessResponse

object

projection

required

object

reservationBookingId

required

string

>= 1 characters

customerActorKey

required

string

>= 1 characters

readinessStatus

required

string

Allowed values: instruction_missing instruction_unavailable grant_missing not_required ready

accountDisclosureGrantRequired

required

boolean

serviceBalancePaymentInstructionId

required

string | null

>= 1 characters

serviceBalanceStatementRevisionKey

required

string | null

>= 1 characters

blockingFacts

required

Array<string>

sourceEvidenceKeys

required

Array<string>

projectedAt

required

string format: date-time

rawAccountFieldsVisible

required

boolean

key

additional properties

Any of:

key

additional properties

401

Supabase bearer token is required

403

Customer session is not active

422

Invalid reservation booking id

503

Customer service-balance caregiver account disclosure reader is unavailable