DDroomwork Developers

Error index

Every code this API can return, what it means, and what to do about it. A code is stable forever once published. Branch on code, never on the title or the detail.

CodeWhat it means
conflict
409
The record is not in a state that allows this

Retrieve the record and check its status before you retry.

  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • POST /v1/identity/passports
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
Show 84 more
  • POST /v1/identity/verifications/{verification_id}/block
  • POST /v1/credentials/wallets
  • POST /v1/credentials/claims
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/classify
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • POST /v1/sourcing/deliveries
  • POST /v1/sourcing/leads
  • POST /v1/sourcing/leads/{lead_id}/promote
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • POST /v1/allocation/heartbeats
  • PUT /v1/allocation/availability/{worker_id}
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • POST /v1/allocation/assignments
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • POST /v1/payroll/runs
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • POST /v1/remittance/obligations
  • POST /v1/remittance/remittances
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • POST /v1/remittance/receipts
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • POST /v1/payouts/instructions
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/route_plans
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • POST /v1/payouts/settlements
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • POST /v1/registrations
  • POST /v1/webhook_endpoints/{id}/test
engagement_not_current
422
The engagement is not executed and current

Take the engagement to EXECUTED and register it before any work or payment.

  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
forbidden
403
Your credential doesn't carry the required scope

Check the scopes on your client against the scope this endpoint names.

  • POST /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications
  • POST /v1/identity/verifications
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
Show 317 more
  • POST /v1/identity/verification_batches
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/sources
  • GET /v1/identity/passports
  • POST /v1/identity/passports
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures
  • POST /v1/identity/disclosures
  • GET /v1/identity/disclosures/reconcile
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/access_grants
  • GET /v1/identity/gating_contract
  • GET /v1/identity/readiness
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications
  • POST /v1/credentials/verifications
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks
  • GET /v1/credentials/frameworks/{framework_id}
  • POST /v1/credentials/document_analyses
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets
  • POST /v1/credentials/wallets
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims
  • POST /v1/credentials/claims
  • GET /v1/credentials/claims/{claim_id}
  • GET /v1/credentials/disclosures
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • GET /v1/credentials/readiness
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • GET /v1/rail/engagements
  • POST /v1/rail/engagements
  • GET /v1/rail/reconcile
  • GET /v1/rail/envelopes
  • GET /v1/rail/instruments
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/gating_contract
  • GET /v1/rail/readiness
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • GET /v1/sourcing/deliveries
  • POST /v1/sourcing/deliveries
  • GET /v1/sourcing/spend_ceilings
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads
  • POST /v1/sourcing/leads
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/analytics
  • GET /v1/sourcing/readiness
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • GET /v1/allocation/integrity_flags
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders
  • POST /v1/allocation/work_orders
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/dispersion
  • GET /v1/allocation/assignments
  • POST /v1/allocation/assignments
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • GET /v1/allocation/proofs
  • GET /v1/allocation/exceptions
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • GET /v1/allocation/supply_gaps
  • GET /v1/allocation/readiness
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs
  • POST /v1/payroll/runs
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles
  • POST /v1/pay_profiles
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries
  • POST /v1/payroll/roster_entries
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports
  • POST /v1/payroll/imports
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/readiness
  • GET /v1/payroll/events
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports
  • POST /v1/remittance/imports
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations
  • POST /v1/remittance/obligations
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities
  • GET /v1/remittance/authorities/{authority_id}
  • GET /v1/remittance/remittances
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts
  • POST /v1/remittance/receipts
  • GET /v1/remittance/receipts/{receipt_id}
  • POST /v1/remittance/audit_exports
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns
  • POST /v1/remittance/returns
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • GET /v1/remittance/readiness
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions
  • POST /v1/payouts/instructions
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans
  • POST /v1/payouts/route_plans
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations
  • POST /v1/payouts/account_validations
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements
  • POST /v1/payouts/settlements
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • GET /v1/payouts/readiness
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • POST /v1/oauth/token
  • POST /v1/api_keys
  • GET /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • GET /v1/support_access
  • POST /v1/account/api_keys
  • POST /v1/account/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • GET /v1/webhook_endpoints
  • GET /v1/webhook_endpoints/{id}
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • GET /v1/webhook_deliveries
  • GET /v1/webhook_deliveries/{id}
  • POST /v1/webhook_deliveries/{id}/replay
  • GET /v1/ledger/accounts
  • GET /v1/ledger/postings
  • GET /v1/ledger/postings/{posting_id}
idempotency_key_reused
409
You've already used this idempotency key with a different request body

Use a fresh key, or resend the original body to get the original response.

  • POST /v1/identity/consent_tokens
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • POST /v1/identity/verifications
  • POST /v1/identity/verification_batches
  • POST /v1/identity/passports
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
Show 118 more
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • POST /v1/identity/disclosures
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • POST /v1/identity/access_grants
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • POST /v1/credentials/verifications
  • POST /v1/credentials/document_analyses
  • POST /v1/credentials/wallets
  • POST /v1/credentials/claims
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • POST /v1/credentials/reattestations
  • POST /v1/credentials/appeals
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • POST /v1/rail/engagements
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/classify
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • POST /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • POST /v1/sourcing/deliveries
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • POST /v1/sourcing/leads
  • POST /v1/sourcing/leads/{lead_id}/promote
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • POST /v1/allocation/heartbeats
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • POST /v1/allocation/assignments
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • POST /v1/payroll/runs
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • POST /v1/pay_profiles
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • POST /v1/payroll/roster_entries
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • POST /v1/payroll/imports
  • POST /v1/payroll/runs/{run_id}/gl_export
  • POST /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • POST /v1/remittance/imports
  • POST /v1/remittance/obligations
  • POST /v1/remittance/remittances
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • POST /v1/remittance/receipts
  • POST /v1/remittance/audit_exports
  • POST /v1/remittance/returns
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • POST /v1/payouts/instructions
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/route_plans
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • POST /v1/payouts/account_validations
  • POST /v1/payouts/settlements
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • POST /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • POST /v1/webhook_deliveries/{id}/replay
internal_error
500
Something failed on our side

Retry. If it persists, quote the request_id when you contact support.

  • POST /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications
  • POST /v1/identity/verifications
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
Show 321 more
  • POST /v1/identity/verification_batches
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/sources
  • GET /v1/identity/passports
  • POST /v1/identity/passports
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures
  • POST /v1/identity/disclosures
  • GET /v1/identity/disclosures/reconcile
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/access_grants
  • GET /v1/identity/gating_contract
  • GET /v1/identity/readiness
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications
  • POST /v1/credentials/verifications
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks
  • GET /v1/credentials/frameworks/{framework_id}
  • POST /v1/credentials/document_analyses
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets
  • POST /v1/credentials/wallets
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims
  • POST /v1/credentials/claims
  • GET /v1/credentials/claims/{claim_id}
  • GET /v1/credentials/disclosures
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • GET /v1/credentials/readiness
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • GET /v1/rail/engagements
  • POST /v1/rail/engagements
  • GET /v1/rail/reconcile
  • GET /v1/rail/envelopes
  • GET /v1/rail/instruments
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/gating_contract
  • GET /v1/rail/readiness
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • GET /v1/sourcing/deliveries
  • POST /v1/sourcing/deliveries
  • GET /v1/sourcing/spend_ceilings
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads
  • POST /v1/sourcing/leads
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/analytics
  • GET /v1/sourcing/readiness
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • GET /v1/allocation/integrity_flags
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders
  • POST /v1/allocation/work_orders
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/dispersion
  • GET /v1/allocation/assignments
  • POST /v1/allocation/assignments
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • GET /v1/allocation/proofs
  • GET /v1/allocation/exceptions
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • GET /v1/allocation/supply_gaps
  • GET /v1/allocation/readiness
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs
  • POST /v1/payroll/runs
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles
  • POST /v1/pay_profiles
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries
  • POST /v1/payroll/roster_entries
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports
  • POST /v1/payroll/imports
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/readiness
  • GET /v1/payroll/events
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports
  • POST /v1/remittance/imports
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations
  • POST /v1/remittance/obligations
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities
  • GET /v1/remittance/authorities/{authority_id}
  • GET /v1/remittance/remittances
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts
  • POST /v1/remittance/receipts
  • GET /v1/remittance/receipts/{receipt_id}
  • POST /v1/remittance/audit_exports
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns
  • POST /v1/remittance/returns
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • GET /v1/remittance/readiness
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions
  • POST /v1/payouts/instructions
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans
  • POST /v1/payouts/route_plans
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations
  • POST /v1/payouts/account_validations
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements
  • POST /v1/payouts/settlements
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • GET /v1/payouts/readiness
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • POST /v1/registrations
  • POST /v1/sessions
  • POST /v1/oauth/token
  • POST /v1/api_keys
  • GET /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • GET /v1/support_access
  • GET /v1/me
  • POST /v1/account/password
  • POST /v1/account/api_keys
  • POST /v1/account/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • GET /v1/webhook_endpoints
  • GET /v1/webhook_endpoints/{id}
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • GET /v1/webhook_deliveries
  • GET /v1/webhook_deliveries/{id}
  • POST /v1/webhook_deliveries/{id}/replay
  • GET /v1/ledger/accounts
  • GET /v1/ledger/postings
  • GET /v1/ledger/postings/{posting_id}
invalid_money_amount
400
Amount must be a whole number of minor units

Send the amount in minor units as a whole number. For NGN that is kobo, so 1234567 is twelve thousand three hundred and forty five naira and sixty seven kobo. Never divide by a hundred by hand.

  • POST /v1/sourcing/requisitions
  • POST /v1/allocation/work_orders
  • POST /v1/pay_profiles
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • POST /v1/remittance/receipts
  • POST /v1/payouts/instructions
invalid_request
400
We couldn't read your request

Check your body against the schema for this endpoint.

  • POST /v1/identity/consent_tokens
  • POST /v1/identity/verifications
  • POST /v1/identity/verification_batches
  • POST /v1/identity/passports
  • POST /v1/identity/merges
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/disclosures
  • POST /v1/identity/subject_requests
Show 63 more
  • POST /v1/identity/access_grants
  • POST /v1/credentials/verifications
  • POST /v1/credentials/document_analyses
  • POST /v1/credentials/wallets
  • POST /v1/credentials/claims
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/reattestations
  • POST /v1/credentials/appeals
  • POST /v1/rail/engagements
  • POST /v1/rail/instruments/verify
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/imports
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • POST /v1/sourcing/deliveries
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • POST /v1/sourcing/leads
  • POST /v1/allocation/heartbeats
  • PUT /v1/allocation/availability/{worker_id}
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • POST /v1/allocation/assignments
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • POST /v1/payroll/runs
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • POST /v1/pay_profiles
  • POST /v1/payroll/roster_entries
  • POST /v1/payroll/imports
  • POST /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • POST /v1/remittance/imports
  • POST /v1/remittance/obligations
  • POST /v1/remittance/remittances
  • POST /v1/remittance/receipts
  • POST /v1/remittance/audit_exports
  • POST /v1/remittance/returns
  • POST /v1/payouts/instructions
  • POST /v1/payouts/route_plans
  • POST /v1/payouts/account_validations
  • POST /v1/payouts/settlements
  • POST /v1/registrations
  • POST /v1/sessions
  • POST /v1/oauth/token
  • POST /v1/api_keys
  • GET /v1/support_access
  • POST /v1/account/password
  • POST /v1/account/api_keys
  • POST /v1/webhook_endpoints
  • GET /v1/ledger/postings
missing_idempotency_key
400
This endpoint requires an idempotency key

Send a unique Idempotency-Key header on every state changing request.

  • POST /v1/identity/consent_tokens
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • POST /v1/identity/verifications
  • POST /v1/identity/verification_batches
  • POST /v1/identity/passports
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
Show 118 more
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • POST /v1/identity/disclosures
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • POST /v1/identity/access_grants
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • POST /v1/credentials/verifications
  • POST /v1/credentials/document_analyses
  • POST /v1/credentials/wallets
  • POST /v1/credentials/claims
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • POST /v1/credentials/reattestations
  • POST /v1/credentials/appeals
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • POST /v1/rail/engagements
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/classify
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • POST /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • POST /v1/sourcing/deliveries
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • POST /v1/sourcing/leads
  • POST /v1/sourcing/leads/{lead_id}/promote
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • POST /v1/allocation/heartbeats
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • POST /v1/allocation/assignments
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • POST /v1/payroll/runs
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • POST /v1/pay_profiles
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • POST /v1/payroll/roster_entries
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • POST /v1/payroll/imports
  • POST /v1/payroll/runs/{run_id}/gl_export
  • POST /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • POST /v1/remittance/imports
  • POST /v1/remittance/obligations
  • POST /v1/remittance/remittances
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • POST /v1/remittance/receipts
  • POST /v1/remittance/audit_exports
  • POST /v1/remittance/returns
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • POST /v1/payouts/instructions
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/route_plans
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • POST /v1/payouts/account_validations
  • POST /v1/payouts/settlements
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • POST /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • POST /v1/webhook_deliveries/{id}/replay
not_entitled
403
Your organisation hasn't bought this module

Your credential is valid, but your organisation doesn't hold this module. Ask your account manager. In the sandbox you hold every module, so a call refused here and allowed there is the realm and not a fault.

  • POST /v1/identity/consent_tokens
  • POST /v1/identity/verifications
  • POST /v1/identity/verification_batches
  • POST /v1/identity/passports
  • POST /v1/identity/merges
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/disclosures
  • POST /v1/identity/subject_requests
Show 32 more
  • POST /v1/identity/access_grants
  • POST /v1/credentials/verifications
  • POST /v1/credentials/document_analyses
  • POST /v1/credentials/wallets
  • POST /v1/credentials/claims
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/reattestations
  • POST /v1/credentials/appeals
  • POST /v1/rail/engagements
  • POST /v1/rail/instruments/verify
  • POST /v1/sourcing/requisitions
  • POST /v1/sourcing/imports
  • POST /v1/sourcing/deliveries
  • POST /v1/sourcing/leads
  • POST /v1/allocation/heartbeats
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/assignments
  • POST /v1/payroll/runs
  • POST /v1/pay_profiles
  • POST /v1/payroll/roster_entries
  • POST /v1/payroll/imports
  • POST /v1/remittance/instruction_sets
  • POST /v1/remittance/imports
  • POST /v1/remittance/obligations
  • POST /v1/remittance/remittances
  • POST /v1/remittance/receipts
  • POST /v1/remittance/audit_exports
  • POST /v1/remittance/returns
  • POST /v1/payouts/instructions
  • POST /v1/payouts/route_plans
  • POST /v1/payouts/account_validations
  • POST /v1/payouts/settlements
not_found
404
No record with that identifier

Check the identifier, including its prefix.

  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges/{merge_id}/reverse
Show 192 more
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks/{framework_id}
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims/{claim_id}
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities/{authority_id}
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts/{receipt_id}
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • POST /v1/api_keys/{id}/revoke
  • POST /v1/account/api_keys/{id}/revoke
  • GET /v1/webhook_endpoints/{id}
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • GET /v1/webhook_deliveries/{id}
  • POST /v1/webhook_deliveries/{id}/replay
  • GET /v1/ledger/postings/{posting_id}
organisation_mismatch
403
The record belongs to another organisation

Use a credential issued to the organisation that owns the record.

  • POST /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications
  • POST /v1/identity/verifications
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
Show 301 more
  • POST /v1/identity/verification_batches
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/sources
  • GET /v1/identity/passports
  • POST /v1/identity/passports
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures
  • POST /v1/identity/disclosures
  • GET /v1/identity/disclosures/reconcile
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/access_grants
  • GET /v1/identity/gating_contract
  • GET /v1/identity/readiness
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications
  • POST /v1/credentials/verifications
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks
  • GET /v1/credentials/frameworks/{framework_id}
  • POST /v1/credentials/document_analyses
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets
  • POST /v1/credentials/wallets
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims
  • POST /v1/credentials/claims
  • GET /v1/credentials/claims/{claim_id}
  • GET /v1/credentials/disclosures
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • GET /v1/credentials/readiness
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • GET /v1/rail/engagements
  • POST /v1/rail/engagements
  • GET /v1/rail/reconcile
  • GET /v1/rail/envelopes
  • GET /v1/rail/instruments
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/gating_contract
  • GET /v1/rail/readiness
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • GET /v1/sourcing/deliveries
  • POST /v1/sourcing/deliveries
  • GET /v1/sourcing/spend_ceilings
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads
  • POST /v1/sourcing/leads
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/analytics
  • GET /v1/sourcing/readiness
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • GET /v1/allocation/integrity_flags
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders
  • POST /v1/allocation/work_orders
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/dispersion
  • GET /v1/allocation/assignments
  • POST /v1/allocation/assignments
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • GET /v1/allocation/proofs
  • GET /v1/allocation/exceptions
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • GET /v1/allocation/supply_gaps
  • GET /v1/allocation/readiness
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs
  • POST /v1/payroll/runs
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles
  • POST /v1/pay_profiles
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries
  • POST /v1/payroll/roster_entries
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports
  • POST /v1/payroll/imports
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/readiness
  • GET /v1/payroll/events
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports
  • POST /v1/remittance/imports
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations
  • POST /v1/remittance/obligations
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities
  • GET /v1/remittance/authorities/{authority_id}
  • GET /v1/remittance/remittances
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts
  • POST /v1/remittance/receipts
  • GET /v1/remittance/receipts/{receipt_id}
  • POST /v1/remittance/audit_exports
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns
  • POST /v1/remittance/returns
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • GET /v1/remittance/readiness
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions
  • POST /v1/payouts/instructions
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans
  • POST /v1/payouts/route_plans
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations
  • POST /v1/payouts/account_validations
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements
  • POST /v1/payouts/settlements
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • GET /v1/payouts/readiness
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • GET /v1/ledger/accounts
  • GET /v1/ledger/postings
  • GET /v1/ledger/postings/{posting_id}
password_reset_required
403
The password you gave is temporary, and you need to replace it first

Set a password of your own with the reset endpoint, using the temporary one as the current password. Keep the session it returns.

  • POST /v1/sessions
payload_too_large
413
Your request body is larger than this API accepts

Send a body of at most 1048576 bytes, which is one mebibyte. Split a larger upload across more than one request. The response names the limit and the length you declared, so you have both numbers.

Returned by the platform rather than by one endpoint.
prerequisite_not_met
422
A required fact is missing

Call the readiness endpoint for this module to see what's missing and what assurance each fact you hold carries.

  • POST /v1/identity/verifications
  • POST /v1/identity/disclosures
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • POST /v1/credentials/verifications
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/claims/{claim_id}/lapse
Show 48 more
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • POST /v1/rail/engagements
  • POST /v1/rail/engagements/{engagement_id}/classify
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • POST /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • POST /v1/payroll/runs
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/pay_profiles
  • POST /v1/payroll/roster_entries
  • POST /v1/remittance/instruction_sets
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • POST /v1/remittance/returns
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • POST /v1/payouts/instructions
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
provider_timeout
504
A provider didn't answer in time

The state is unknown, not failed. Poll the operation until it resolves. Don't resend on a new key.

Returned by the platform rather than by one endpoint.
rate_limited
429
Too many requests

Back off and retry after the interval in the Retry-After header.

  • POST /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications
  • POST /v1/identity/verifications
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
Show 321 more
  • POST /v1/identity/verification_batches
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/sources
  • GET /v1/identity/passports
  • POST /v1/identity/passports
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures
  • POST /v1/identity/disclosures
  • GET /v1/identity/disclosures/reconcile
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/access_grants
  • GET /v1/identity/gating_contract
  • GET /v1/identity/readiness
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications
  • POST /v1/credentials/verifications
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks
  • GET /v1/credentials/frameworks/{framework_id}
  • POST /v1/credentials/document_analyses
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets
  • POST /v1/credentials/wallets
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims
  • POST /v1/credentials/claims
  • GET /v1/credentials/claims/{claim_id}
  • GET /v1/credentials/disclosures
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • GET /v1/credentials/readiness
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • GET /v1/rail/engagements
  • POST /v1/rail/engagements
  • GET /v1/rail/reconcile
  • GET /v1/rail/envelopes
  • GET /v1/rail/instruments
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/gating_contract
  • GET /v1/rail/readiness
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • GET /v1/sourcing/deliveries
  • POST /v1/sourcing/deliveries
  • GET /v1/sourcing/spend_ceilings
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads
  • POST /v1/sourcing/leads
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/analytics
  • GET /v1/sourcing/readiness
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • GET /v1/allocation/integrity_flags
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders
  • POST /v1/allocation/work_orders
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/dispersion
  • GET /v1/allocation/assignments
  • POST /v1/allocation/assignments
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • GET /v1/allocation/proofs
  • GET /v1/allocation/exceptions
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • GET /v1/allocation/supply_gaps
  • GET /v1/allocation/readiness
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs
  • POST /v1/payroll/runs
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles
  • POST /v1/pay_profiles
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries
  • POST /v1/payroll/roster_entries
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports
  • POST /v1/payroll/imports
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/readiness
  • GET /v1/payroll/events
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports
  • POST /v1/remittance/imports
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations
  • POST /v1/remittance/obligations
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities
  • GET /v1/remittance/authorities/{authority_id}
  • GET /v1/remittance/remittances
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts
  • POST /v1/remittance/receipts
  • GET /v1/remittance/receipts/{receipt_id}
  • POST /v1/remittance/audit_exports
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns
  • POST /v1/remittance/returns
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • GET /v1/remittance/readiness
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions
  • POST /v1/payouts/instructions
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans
  • POST /v1/payouts/route_plans
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations
  • POST /v1/payouts/account_validations
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements
  • POST /v1/payouts/settlements
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • GET /v1/payouts/readiness
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • POST /v1/registrations
  • POST /v1/sessions
  • POST /v1/oauth/token
  • POST /v1/api_keys
  • GET /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • GET /v1/support_access
  • GET /v1/me
  • POST /v1/account/password
  • POST /v1/account/api_keys
  • POST /v1/account/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • GET /v1/webhook_endpoints
  • GET /v1/webhook_endpoints/{id}
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • GET /v1/webhook_deliveries
  • GET /v1/webhook_deliveries/{id}
  • POST /v1/webhook_deliveries/{id}/replay
  • GET /v1/ledger/accounts
  • GET /v1/ledger/postings
  • GET /v1/ledger/postings/{posting_id}
source_unresolved
502
An external register didn't answer

You get an unresolved result that names the source. We never read silence as a pass. Retry, or proceed on a different evidence class.

  • POST /v1/identity/verifications
  • POST /v1/credentials/verifications
stale_local_copy
503
The data this operation depends on is older than it allows

Retry shortly. We won't run an operation with money or legal consequences on stale data.

Returned by the platform rather than by one endpoint.
subject_not_anchored
422
The subject has no anchored identity

Supply an ANCHOR identity, or, if you run this module standalone, register a supplied identity under an attestation.

  • POST /v1/credentials/verifications
  • POST /v1/credentials/disclosures
  • POST /v1/rail/engagements
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • POST /v1/allocation/work_orders
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/payroll/runs/{run_id}/execute
Show 2 more
  • POST /v1/pay_profiles
  • POST /v1/payroll/roster_entries
unauthenticated
401
You didn't present a valid credential

Send a bearer token from the client credentials grant, or an API key.

  • POST /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens
  • GET /v1/identity/consent_tokens/{consent_token_id}
  • POST /v1/identity/consent_tokens/{consent_token_id}/revoke
  • GET /v1/identity/verifications
  • POST /v1/identity/verifications
  • GET /v1/identity/verifications/{verification_id}
  • GET /v1/identity/verifications/{verification_id}/evidence_bundle
Show 320 more
  • POST /v1/identity/verification_batches
  • GET /v1/identity/verification_batches/{batch_id}
  • GET /v1/identity/sources
  • GET /v1/identity/passports
  • POST /v1/identity/passports
  • GET /v1/identity/passports/{passport_id}
  • GET /v1/identity/merge_candidates
  • GET /v1/identity/merge_candidates/{merge_candidate_id}
  • POST /v1/identity/merges
  • POST /v1/identity/merges/{merge_id}/reverse
  • POST /v1/identity/blocklist_entries
  • POST /v1/identity/blocklist_entries/{blocklist_entry_id}/reverse
  • GET /v1/identity/disclosures
  • POST /v1/identity/disclosures
  • GET /v1/identity/disclosures/reconcile
  • GET /v1/identity/disclosures/{disclosure_id}
  • POST /v1/identity/disclosures/{disclosure_id}/revoke
  • POST /v1/identity/subject_requests
  • GET /v1/identity/subject_requests/{subject_request_id}
  • POST /v1/identity/access_grants
  • GET /v1/identity/gating_contract
  • GET /v1/identity/readiness
  • POST /v1/identity/verifications/{verification_id}/resolve
  • POST /v1/identity/verifications/{verification_id}/mark_unresolved
  • POST /v1/identity/verifications/{verification_id}/block
  • GET /v1/identity/events
  • GET /v1/identity/events/{event_id}
  • GET /v1/identity/audit_entries
  • GET /v1/identity/audit_entries/{audit_entry_id}
  • GET /v1/credentials/verifications
  • POST /v1/credentials/verifications
  • GET /v1/credentials/verifications/{verification_id}
  • GET /v1/credentials/issuers
  • GET /v1/credentials/issuers/{issuer_id}
  • GET /v1/credentials/frameworks
  • GET /v1/credentials/frameworks/{framework_id}
  • POST /v1/credentials/document_analyses
  • GET /v1/credentials/document_analyses/{document_analysis_id}
  • GET /v1/credentials/wallets
  • POST /v1/credentials/wallets
  • GET /v1/credentials/wallets/{wallet_id}
  • GET /v1/credentials/claims
  • POST /v1/credentials/claims
  • GET /v1/credentials/claims/{claim_id}
  • GET /v1/credentials/disclosures
  • POST /v1/credentials/disclosures
  • POST /v1/credentials/disclosures/{disclosure_id}/revoke
  • GET /v1/credentials/licences
  • GET /v1/credentials/licences/{licence_id}
  • POST /v1/credentials/reattestations
  • GET /v1/credentials/reattestations/{reattestation_id}
  • POST /v1/credentials/appeals
  • GET /v1/credentials/appeals/{appeal_id}
  • GET /v1/credentials/readiness
  • POST /v1/credentials/claims/{claim_id}/lapse
  • POST /v1/credentials/verifications/{verification_id}/verify
  • POST /v1/credentials/verifications/{verification_id}/mark_unverified
  • POST /v1/credentials/verifications/{verification_id}/contradict
  • GET /v1/credentials/events
  • GET /v1/credentials/events/{event_id}
  • GET /v1/credentials/audit_entries
  • GET /v1/credentials/audit_entries/{audit_entry_id}
  • GET /v1/rail/engagements
  • POST /v1/rail/engagements
  • GET /v1/rail/reconcile
  • GET /v1/rail/envelopes
  • GET /v1/rail/instruments
  • POST /v1/rail/instruments/verify
  • GET /v1/rail/clause_library
  • GET /v1/rail/remediation_cases
  • GET /v1/rail/remediation_cases/{remediation_case_id}
  • POST /v1/rail/remediation_cases/{remediation_case_id}/resolve
  • GET /v1/rail/gating_contract
  • GET /v1/rail/readiness
  • GET /v1/rail/engagements/{engagement_id}
  • POST /v1/rail/engagements/{engagement_id}/classify
  • GET /v1/rail/engagements/{engagement_id}/classification
  • GET /v1/rail/engagements/{engagement_id}/classification/rationale
  • POST /v1/rail/engagements/{engagement_id}/terminate
  • POST /v1/rail/engagements/{engagement_id}/attestations
  • GET /v1/rail/engagements/{engagement_id}/attestations/{attestation_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/supersede
  • POST /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/assents/{assent_id}
  • GET /v1/rail/engagements/{engagement_id}/instruments/{instrument_id}/copy
  • GET /v1/rail/engagements/{engagement_id}/envelope
  • GET /v1/rail/engagements/{engagement_id}/discharges
  • POST /v1/rail/engagements/{engagement_id}/disputes
  • POST /v1/rail/engagements/{engagement_id}/disputes/{dispute_id}/resolve
  • POST /v1/rail/engagements/{engagement_id}/audit_bundles
  • GET /v1/rail/engagements/{engagement_id}/audit_bundles/{audit_bundle_id}
  • POST /v1/rail/engagements/{engagement_id}/paper
  • POST /v1/rail/engagements/{engagement_id}/execute
  • POST /v1/rail/engagements/{engagement_id}/register
  • POST /v1/rail/engagements/{engagement_id}/activate
  • POST /v1/rail/engagements/{engagement_id}/lapse
  • POST /v1/rail/engagements/{engagement_id}/dispute
  • GET /v1/rail/events
  • GET /v1/rail/events/{event_id}
  • GET /v1/rail/audit_entries
  • GET /v1/rail/audit_entries/{audit_entry_id}
  • GET /v1/sourcing/requisitions
  • POST /v1/sourcing/requisitions
  • GET /v1/sourcing/requisitions/{requisition_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/confirm_inferences
  • POST /v1/sourcing/requisitions/{requisition_id}/publish
  • POST /v1/sourcing/requisitions/{requisition_id}/close
  • POST /v1/sourcing/imports
  • GET /v1/sourcing/imports/{import_id}
  • GET /v1/sourcing/taxonomies/{taxonomy_id}
  • GET /v1/sourcing/channels
  • GET /v1/sourcing/channels/{channel_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts
  • GET /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • PATCH /v1/sourcing/requisitions/{requisition_id}/artefacts/{artefact_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/broadcasts
  • GET /v1/sourcing/broadcasts/{broadcast_id}
  • POST /v1/sourcing/broadcasts/{broadcast_id}/deliveries/{delivery_id}/retry
  • GET /v1/sourcing/deliveries
  • POST /v1/sourcing/deliveries
  • GET /v1/sourcing/spend_ceilings
  • POST /v1/sourcing/requisitions/{requisition_id}/capture_links
  • GET /v1/sourcing/capture_links/{capture_link_id}
  • GET /v1/sourcing/requisitions/{requisition_id}/knockout_rules
  • GET /v1/sourcing/leads
  • POST /v1/sourcing/leads
  • GET /v1/sourcing/leads/{lead_id}
  • GET /v1/sourcing/leads/{lead_id}/screening
  • POST /v1/sourcing/leads/{lead_id}/promote
  • GET /v1/sourcing/leads/{lead_id}/attribution
  • GET /v1/sourcing/analytics
  • GET /v1/sourcing/readiness
  • GET /v1/sourcing/deliveries/{delivery_id}
  • POST /v1/sourcing/requisitions/{requisition_id}/quarantine
  • GET /v1/sourcing/events
  • GET /v1/sourcing/events/{event_id}
  • GET /v1/sourcing/audit_entries
  • GET /v1/sourcing/audit_entries/{audit_entry_id}
  • POST /v1/allocation/heartbeats
  • GET /v1/allocation/supply_states
  • GET /v1/allocation/supply_states/{worker_id}
  • PUT /v1/allocation/availability/{worker_id}
  • GET /v1/allocation/integrity_flags
  • POST /v1/allocation/integrity_flags/{integrity_flag_id}/adjudicate
  • GET /v1/allocation/work_orders
  • POST /v1/allocation/work_orders
  • GET /v1/allocation/work_orders/{work_order_id}
  • POST /v1/allocation/work_orders/{work_order_id}/cancel
  • GET /v1/allocation/work_orders/{work_order_id}/ranking
  • GET /v1/allocation/work_orders/{work_order_id}/offers
  • GET /v1/allocation/offers/{offer_id}
  • POST /v1/allocation/offers/{offer_id}/accept
  • POST /v1/allocation/offers/{offer_id}/decline
  • GET /v1/allocation/dispersion
  • GET /v1/allocation/assignments
  • POST /v1/allocation/assignments
  • GET /v1/allocation/assignments/{assignment_id}
  • POST /v1/allocation/assignments/{assignment_id}/arrival
  • POST /v1/allocation/assignments/{assignment_id}/completion
  • POST /v1/allocation/assignments/{assignment_id}/cancel
  • GET /v1/allocation/assignments/{assignment_id}/proof
  • GET /v1/allocation/proofs
  • GET /v1/allocation/exceptions
  • POST /v1/allocation/exceptions/{exception_id}/adjudicate
  • GET /v1/allocation/supply_gaps
  • GET /v1/allocation/readiness
  • POST /v1/allocation/assignments/{assignment_id}/start
  • POST /v1/allocation/assignments/{assignment_id}/arrive
  • POST /v1/allocation/assignments/{assignment_id}/depart
  • POST /v1/allocation/assignments/{assignment_id}/complete
  • POST /v1/allocation/assignments/{assignment_id}/raise_exception
  • POST /v1/allocation/work_orders/{work_order_id}/offer
  • POST /v1/allocation/work_orders/{work_order_id}/fill
  • POST /v1/allocation/work_orders/{work_order_id}/expire
  • GET /v1/allocation/events
  • GET /v1/allocation/events/{event_id}
  • GET /v1/allocation/audit_entries
  • GET /v1/allocation/audit_entries/{audit_entry_id}
  • GET /v1/payroll/runs
  • POST /v1/payroll/runs
  • GET /v1/payroll/runs/{run_id}
  • PATCH /v1/payroll/runs/{run_id}
  • POST /v1/payroll/runs/{run_id}/simulate
  • POST /v1/payroll/runs/{run_id}/approve
  • POST /v1/payroll/runs/{run_id}/execute
  • POST /v1/payroll/runs/{run_id}/cancel
  • GET /v1/payroll/runs/{run_id}/totals
  • GET /v1/payroll/runs/{run_id}/findings
  • GET /v1/payroll/runs/{run_id}/findings/{finding_id}
  • POST /v1/payroll/runs/{run_id}/findings/{finding_id}/resolve
  • GET /v1/payroll/payslips
  • GET /v1/payroll/payslips/{payslip_id}
  • POST /v1/payroll/payslips/{payslip_id}/replay
  • GET /v1/payroll/payslips/{payslip_id}/explanation
  • POST /v1/payroll/payslips/{payslip_id}/issue
  • GET /v1/payroll/payslips/{payslip_id}/document
  • GET /v1/pay_profiles
  • POST /v1/pay_profiles
  • GET /v1/pay_profiles/{pay_profile_id}
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • GET /v1/payroll/roster_entries
  • POST /v1/payroll/roster_entries
  • GET /v1/payroll/roster_entries/{roster_entry_id}
  • PATCH /v1/payroll/roster_entries/{roster_entry_id}
  • GET /v1/payroll/imports
  • POST /v1/payroll/imports
  • GET /v1/payroll/imports/{import_id}
  • GET /v1/payroll/runs/{run_id}/instruction_set
  • POST /v1/payroll/runs/{run_id}/gl_export
  • GET /v1/payroll/runs/{run_id}/gl_export/{gl_export_id}
  • GET /v1/payroll/readiness
  • GET /v1/payroll/events
  • GET /v1/payroll/events/{event_id}
  • GET /v1/payroll/audit_entries
  • GET /v1/payroll/audit_entries/{audit_entry_id}
  • GET /v1/remittance/instruction_sets
  • POST /v1/remittance/instruction_sets
  • GET /v1/remittance/instruction_sets/{instruction_set_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/accept
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/totals
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies
  • GET /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/discrepancies/{discrepancy_id}/override
  • GET /v1/remittance/imports
  • POST /v1/remittance/imports
  • GET /v1/remittance/imports/{import_id}
  • GET /v1/remittance/obligations
  • POST /v1/remittance/obligations
  • GET /v1/remittance/obligations/{obligation_id}
  • GET /v1/remittance/calendar_entries
  • GET /v1/remittance/calendar_entries/{calendar_entry_id}
  • GET /v1/remittance/authorities
  • GET /v1/remittance/authorities/{authority_id}
  • GET /v1/remittance/remittances
  • POST /v1/remittance/remittances
  • GET /v1/remittance/remittances/{remittance_id}
  • POST /v1/remittance/remittances/{remittance_id}/approve
  • GET /v1/remittance/remittances/{remittance_id}/legs
  • GET /v1/remittance/remittances/{remittance_id}/legs/{leg_id}
  • POST /v1/remittance/remittances/{remittance_id}/legs/{leg_id}/retry
  • GET /v1/remittance/receipts
  • POST /v1/remittance/receipts
  • GET /v1/remittance/receipts/{receipt_id}
  • POST /v1/remittance/audit_exports
  • GET /v1/remittance/audit_exports/{audit_export_id}
  • GET /v1/remittance/reconciliations
  • GET /v1/remittance/reconciliations/{reconciliation_id}
  • GET /v1/remittance/returns
  • POST /v1/remittance/returns
  • GET /v1/remittance/returns/{return_id}
  • POST /v1/remittance/returns/{return_id}/approve
  • POST /v1/remittance/returns/{return_id}/submit
  • GET /v1/remittance/readiness
  • POST /v1/remittance/instruction_sets/{instruction_set_id}/reject
  • POST /v1/remittance/remittances/{remittance_id}/execute
  • GET /v1/remittance/events
  • GET /v1/remittance/events/{event_id}
  • GET /v1/remittance/audit_entries
  • GET /v1/remittance/audit_entries/{audit_entry_id}
  • GET /v1/payouts/instructions
  • POST /v1/payouts/instructions
  • GET /v1/payouts/instructions/{instruction_id}
  • GET /v1/payouts/instructions/{instruction_id}/route_plan
  • GET /v1/payouts/instructions/{instruction_id}/funding_check
  • POST /v1/payouts/instructions/{instruction_id}/funding_check
  • GET /v1/payouts/route_plans
  • POST /v1/payouts/route_plans
  • GET /v1/payouts/route_plans/{route_plan_id}
  • GET /v1/payouts/rails
  • GET /v1/payouts/rails/{rail_id}
  • GET /v1/payouts/payouts
  • GET /v1/payouts/payouts/{payout_id}
  • POST /v1/payouts/payouts/{payout_id}/resolve
  • GET /v1/payouts/payouts/{payout_id}/attempts
  • GET /v1/payouts/payouts/{payout_id}/attempts/{attempt_id}
  • GET /v1/payouts/account_validations
  • POST /v1/payouts/account_validations
  • GET /v1/payouts/account_validations/{account_validation_id}
  • GET /v1/payouts/settlements
  • POST /v1/payouts/settlements
  • GET /v1/payouts/settlements/{settlement_id}
  • GET /v1/payouts/settlements/{settlement_id}/receipt
  • GET /v1/payouts/reconciliations
  • GET /v1/payouts/reconciliations/{reconciliation_id}
  • GET /v1/payouts/reconciliations/{reconciliation_id}/exceptions
  • GET /v1/payouts/readiness
  • POST /v1/payouts/instructions/{instruction_id}/execute
  • POST /v1/payouts/instructions/{instruction_id}/fail
  • POST /v1/payouts/instructions/{instruction_id}/mark_unknown
  • POST /v1/payouts/instructions/{instruction_id}/plan
  • POST /v1/payouts/instructions/{instruction_id}/resolve
  • GET /v1/payouts/events
  • GET /v1/payouts/events/{event_id}
  • GET /v1/payouts/audit_entries
  • GET /v1/payouts/audit_entries/{audit_entry_id}
  • POST /v1/sessions
  • POST /v1/oauth/token
  • POST /v1/api_keys
  • GET /v1/api_keys
  • POST /v1/api_keys/{id}/revoke
  • GET /v1/support_access
  • GET /v1/me
  • POST /v1/account/password
  • POST /v1/account/api_keys
  • POST /v1/account/api_keys/{id}/revoke
  • POST /v1/webhook_endpoints
  • GET /v1/webhook_endpoints
  • GET /v1/webhook_endpoints/{id}
  • POST /v1/webhook_endpoints/{id}/rotate_secret
  • POST /v1/webhook_endpoints/{id}/disable
  • POST /v1/webhook_endpoints/{id}/test
  • GET /v1/webhook_deliveries
  • GET /v1/webhook_deliveries/{id}
  • POST /v1/webhook_deliveries/{id}/replay
  • GET /v1/ledger/accounts
  • GET /v1/ledger/postings
  • GET /v1/ledger/postings/{posting_id}
unknown_currency
400
We don't support that currency

Call GET /v1/currencies for the codes this API accepts.

  • POST /v1/sourcing/requisitions
  • POST /v1/allocation/work_orders
  • POST /v1/pay_profiles
  • PATCH /v1/pay_profiles/{pay_profile_id}
  • POST /v1/remittance/receipts
  • POST /v1/payouts/instructions
unsupported_media_type
415
Your request body is in a content type this endpoint can't read

Send your body as JSON and set the header content-type: application/json. Some clients, curl among them, pick a form encoding on their own unless you give them that header.

Returned by the platform rather than by one endpoint.