Reveal a shared passport number

Identity module

POST/work-detail-shares/{id}/reveal-passportworkDetailShares.revealPassport

For a member of the engaging org: returns the passport number through `app.reveal_shared_passport_number`. Needs a live share naming Passport on an open engagement, hospitality.fulfillment.read on the project, data.restricted.read.government_id in the org, step-up authentication (422 step_up_required) and a reason (422 passport_reveal_reason). Logged with the reason, never the value. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability data.restricted.read.government_id.
OAuth scopes: data.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

workDetailShares.revealPassport: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the work detail share.

Request body: PassportRevealRequest

workDetailShares.revealPassport: PassportRevealRequest
Field	Type	Required	Description
reason	string	Yes	Why the number is needed, 10 to 500 characters. Logged with the reveal.Constraints: length 10 to 500

{
  "reason": "Booking the June flights."
}

Response 200: PassportReveal

workDetailShares.revealPassport: PassportReveal
Field	Type	Required	Description
passport_number	string	Yes	The passport number in plain text.

{
  "passport_number": "YA0000TEST"
}

Code samples

curl -X POST "$XOS_BASE_URL/work-detail-shares/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/reveal-passport" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Booking the June flights."}'

const { data } = await xos.workDetailShares.revealPassport("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "reason": "Booking the June flights."
  });

response = xos.work_detail_shares.reveal_passport("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"reason": "Booking the June flights."})

xos work-detail-shares reveal-passport 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"reason":"Booking the June flights."}'