Okra IDs
Dive deep into the different IDs that Okra uses and learn how you can ensure data continuity in your app.
This guide helps you understand the most important IDs that the Okra API uses, and offer some general best practices on how you can ensure data continuity in you applications.
The Okra API uses universal unique identifiers (uuids) to identify specific data properties and records. These IDs are used across multiple endpoints to refer to the same information. For example, you can use a customer id to retrieve a user’s KYC profile, then use the same customer id to manage the customer's record.
Customer ID
| Description | Used in | Best practices |
|---|---|---|
| This ID uniquely identifies a single user, like a name. | - API request and response payloads - the Okra Dashboard | Okra recommends that you save customer IDs in your DB. This enables you to identify users in your workflows, and to retrieve data for specific users through endpoints like Search identity. |
Account ID
| Description | Used in | Best practices |
|---|---|---|
| This ID uniquely identifies a user's connected account, and the bank it belongs to. | - API request and response payloads | Okra recommends that you save account IDs in your DB. In the onSuccess callback payload, the connected boolean shows when a specific account is connected to your application. Use it to confirm that you are saving the correct account ID. |
Product IDs
| Description | Used in | Best practices |
|---|---|---|
| These IDs uniquely identify product records for a connected user within your application. All Okra products have an ID, for example a connected user's data profile can contain transaction IDs, payment IDs, balance IDs, and so on. | - API request and response payloads | Okra recommends that you save product IDs in your DB. When a user connects their accounts via the Okra app, the API processes the user's account data. The API creates new records for every product that you set up when initializing the Okra app. Use the IDs of these product records to retrieve the data that the API processed. For example, you set up an app and enable the Identity product. When a user connects their account in that app instance, the API creates an Identity record. You can use the Identity record's id to retrieve the Identity profile of that user. |
Bank ID
| Description | Used in | Best practices |
|---|---|---|
| This ID uniquely identifies the bank where the customer has an account. Visit Okra's Coverage page for the list of bank IDs. | - API request and response payloads | Okra recommends that you save bank IDs in your DB. |
Use bank IDs to retrieve data from endpoints like NUBAN name verify.
Need help?
- If you encounter any errors during your integration journey, check out the Error documentation.
- If you have any questions about Okra's products or way of working, get in touch with the Support team.
- If you bump into technical issues during your integration, you can open a ticket on Okra's Support portal.