Smile ID
Connect Smile ID to the rest of your business, with the right person approving what changes and a record of every action.
3 ways to read, 1 way to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Smile ID, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Check an ID number
identity_checks.createApproval by rule - Check ID authority availability
id_availability.listRead
Example flow
- Smile ID · Check ID authority availability
id_availability.listDone - Smile ID · Check an ID number
identity_checks.createMaker-checker - Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Smile ID.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Smile ID
- Smile ID's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Smile ID test account before you go live.
For developers
Technical detail
Smile ID: check a person's ID number with the issuing authority across Africa (Enhanced KYC), read check status, supported ID types and authority availability.
Smile ID API docs- Source actions
- 3
- Destination actions
- 1
- Data types
- 3
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
id availability1
- Check ID authority availabilitySource
Whether the government ID service behind an ID type is up, with its recent success rate.
identity checks2
- Check an ID numberDestinationNot retried automaticallyApproval before production
Checks a person's ID number (for example NIN, BVN or a national ID) with the issuing authority through Smile ID Enhanced KYC. The result arrives at your Smile ID trigger.
- Get identity check statusSource
Whether an identity check is clear, needs attention, was blocked or failed. The full result arrives at your Smile ID trigger.
supported id types1
- List supported ID typesSource
The ID types Smile ID can check in a country, with the fields each one needs.
Access and limits
- Authentication
- Smile ID partner ID and API key
- Plans and access
- A Smile ID partner account with API keys from the Smile ID portal; checks are charged per request. ID types and countries depend on the products Smile ID enables for your account.
- Test environment
- Create sandbox keys in the Smile ID portal. The sandbox answers only its published test identities (for example Amina Fatou Clearwater) and charges nothing.
- Rate limits
- Smile ID refuses repeated checks of the same ID number in a short time with HTTP 429; Nexra honours Retry-After and never repeats a check by itself.
- Pagination
- Smile ID returns single results; there are no lists to page.
- Provider events
- Smile ID posts each completed check to your callback address with Response-Signature, Response-Timestamp and Job-ID headers, retrying up to three times. Flows can start the moment something happens: when an identity check is clear; when an identity check needs a review; when an identity check is blocked; when an identity check could not finish.
Before you build a flow
- Checks are charged by Smile ID and are approval-gated like other sensitive writes; Nexra never repeats an uncertain check.
- Results arrive at your Smile ID trigger; Get identity check status returns the status only.
- ID numbers are masked in every result; photos, document links, addresses, phone numbers and e-mail addresses are never passed to flows.
- Business verification (KYB) and document checks are not offered: Smile ID documents business verification only on its older API.
- Smile ID's webhook signature covers the timestamp, not the body; confirm a result with Get identity check status before relying on it.
Developer reference
- Create the Smile ID credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Smile ID, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/smile-id and the Connections API.