Apply for access
How to get sandbox credentials, what OFIS approves and restricts, and the path to production.
How to apply
Email identity@federal.africa with:
- your organisation’s name and what your service does;
- a technical contact;
- the scopes you need and why:
ofis:lookup,ofis:assert,ofis:enroll, and, if you qualify,ofis:issueorofis:entitle; - for Sign in with Federal ID, your redirect URIs (a path wildcard is fine in the sandbox; production URIs are exact);
- for linking, the exact redirect URI OFIS should call back.
OFIS registers a service client in the ofis realm and, if you sign people in, a login client in the citizens realm, and sends you a client_id and client_secret pair for the sandbox. There is no self-service console yet; registration and changes are done by the OFIS team by email.
Approval policy
- Sandbox first, always. Production credentials are issued only after your integration has been exercised against the sandbox fixtures, including the consent-error and not-active cases.
- Every partner can look up and assert.
ofis:lookupandofis:assertare granted to any registered partner with a legitimate use. - Enrollment (
ofis:enroll) goes to partners that offer Sign in with Federal ID and have a registered login client. - Issuing (
ofis:issue) is restricted to partners that onboard people on OFIS’s behalf under an agreement, because it creates identities directly. - Entitlements (
ofis:entitle) go only to apps that sell membership plans: the Federal Africa community platform today, and others by agreement. Every other partner reads a member’s tier through lookup and assertions and needs no extra scope. - Production registration is OFIS’s decision, and it can be withdrawn for a partner that breaks the rules below.
What you agree to
- Verify assertions locally against the published keys; never call OFIS to double-check one.
- Never call OFIS on your hot path: cache, time out at two seconds, break the circuit.
- Show a verified badge only when
verifiedis true andstatusisactive. - Stop asserting an identity the moment consent is revoked; subscribe to
consent.revoked. - Store only a mirror of what you were given. Never collect identity documents on OFIS’s behalf, and never present evidence you do not hold.
- Keep your
client_secretand webhook secrets out of code and logs. Tell OFIS at once if one leaks. - Pin to
/api/v1/and read deprecation notices.
Contact
- Integration support and credential requests: identity@federal.africa
- A security concern: security@federal.africa, see reporting a vulnerability