Build your collection flow

Choose the acting identity#

Use /traveler/cases with a customer token for self-service collection. Use /tenant/cases with a tenant key for authorized backend work. Both enforce the same requirement and submission rules, with different resource access and response projections.

Start with the case requirements#

Product requirements describe what a new application will need. After order creation, render the case’s frozen requirement snapshot and retain requirementsVersion.

Fields include a public ID, type, validation rules, required state, and choice lists. Repeatable groups have explicit item identities. Do not hardcode an internal property path or omit an unsupported required field.

Write typed values#

Use public field IDs and include the requirement version. An omitted field stays unchanged; null clears a value only if the schema permits it.

Preserve the difference between extracted suggestions, traveler-confirmed information, and staff corrections. Processing output should not silently replace confirmed information.

{
  "requirementsVersion": "rv_example",
  "changes": [
    { "fieldId": "passport.expiryDate", "value": "2030-06-30" }
  ],
  "listChanges": []
}

Upload evidence and follow processing#

Upload to the authorized case and document requirement. A 202 response identifies a durable operation; use its Location and Retry-After headers to follow progress.

Processing and review are separate states. A successfully processed file can still need review. In the current business rules, pending-review documents can satisfy the presence requirement; missing, rejected, or superseded evidence cannot.

Check readiness, then submit#

Render all blockers from the readiness response: missing fields, missing evidence, open requests, and initial payment requirements.

Readiness is advisory until submit performs its own checks. A concurrent update may invalidate an earlier readiness result. Refresh and display the returned blockers instead of forcing a stage change.

Handle requests for more information#

Answer ad-hoc questions using the answer endpoint. Satisfy field and document requests by updating the actual field or evidence. Do not mark a request answered without supplying what it asks for.

The case indicates whether explicit resubmission is required. RFE resubmission follows its own workflow boundary and does not simply repeat the initial payment check.