The protocol
The flow is the same for every region:1
Verify the user
Onboard and verify your user as normal (see Onboarding customers). Once
verification.status is verified, check for regional requirements.2
Check requirements
Call
GET /v1/users/me/compliance/requirements. It reports whether this user’s region requires anything and which fields are outstanding.3
Collect and submit
If required, collect the listed fields and submit them together.
Check requirements
required && !complete. Otherwise there is nothing to do — a user outside a regulated region returns required: false, complete: true with an empty fields array, and a user who has already submitted returns complete: true.
Submit the fields
Submit all fields together. Validate on your side first — the request is rejected as a whole if anything is invalid.complianceFieldsComplete is the same signal as complete from the requirements endpoint — once it is true, the regional_compliance requirement clears from the user’s capabilities. bridgeCustomerUpdated reports whether the fields were forwarded to the provider immediately (true) or stored to be sent when the customer is first created (false); either way the fields are captured. After a successful submission, re-fetching requirements returns complete: true.
EEA field reference
These are the fields the EEA requires. A future region would list its own fields in the requirements response; this section is EEA-specific.placeOfBirth
country(required) — ISO 3166-1 alpha-3 code. This is the three-letter code (DEU,FRA,POL), not the two-letter code (DE). This is the most common integration mistake.city— optional today; required by EU law from 2027.
nationalities
accountPurpose
One of the following, plus a free-textaccountPurposeOther when other:
Errors
Errors follow the standard problem-details format.The
detail is a summary, not a per-field list — validate client-side (country codes alpha-3, at least one nationality, a description when the purpose is other) so your users see precise errors before the request is made.Next
Onboarding customers
Create and verify the user before checking compliance.
Errors
Parse problem responses consistently.