Auth
Download SpecOkra API endpoints for authentication
Get Auth by id
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances when available using the id
id
string
bearer
Request
{
"id": "// auth id"
}Response
OK
{
"status": "success",
"message": "Auth retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 1,
"limit": 20,
"hasPrevPage": false,
"hasNextPage": false,
"page": 1,
"totalPages": 1,
"pagingCounter": 1
},
"auths": [
{
"_id": "",
"record": "",
"__v": 0,
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": "",
"v2_icon": "",
"v2_logo": ""
},
"created_at": "",
"customer": {
"_id": "",
"name": ""
},
"env": "",
"last_updated": "",
"owner": "",
"validated": true,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 1, "limit": 20, "hasPrevPage": false, "hasNextPage": false, "page": 1, "totalPages": 1, "pagingCounter": 1 }, "auths": [ { "_id": "", "record": "", "__v": 0, "bank": { "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth)]
Auth
object (Auth)
- Example
- { "_id": "", "record": "", "__v": 0, "bank": { "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" }
_id
string
record
string
__v
int
i32
bank
object (bank)
icon
string
A URL that points to the bank's icon.
logo
string
A URL that points to the bank's logo.
name
string
The bank's name.
slug
string
The bank's name in slug format.
status
string
The current connection status of the bank.
- Enum
-
- down
- degraded
- healthy
- dead
v2_icon
string
A URL that points to the bank's icon.
v2_logo
string
A URL that points to the bank's logo.
created_at
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
env
string
last_updated
string
owner
string
validated
boolean
id
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "11083"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"2b4b-MW0Cx1b09iYa0CaVWPuQ7nHKt7Q\""
Date
string
- Content Type
- text/plain
- Example
- "Fri, 20 Nov 2020 11:56:06 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get Auth by Customer
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances using the customer ID.
customer
string
required
The customer ID you want to get detailed information about.
- Example
- "8h78lka7898dj800"
page
int
i32
required
Return a specific page of results. For example, if you set limit to 20 and set page to 1, the API will return the first page, with 20 results in the response.
- Example
- "1"
limit
int
i32
required
Limit the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
- Example
- "10"
bearer
Request
{
"customer": "8h78lka7898dj800",
"page": "1",
"limit": "10"
}Response
OK
{
"status": "success",
"message": "Auth retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 880,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 880,
"pagingCounter": 1,
"nextPage": 2
},
"auths": [
{
"_id": "",
"record": "",
"__v": 0,
"bank": {
"colors": {
"primary": "",
"accent": "",
"button": ""
},
"icon": "",
"logo": "",
"name": "",
"status": "",
"v2_icon": "",
"v2_logo": ""
},
"created_at": "",
"customer": {
"_id": "",
"name": ""
},
"env": "",
"last_updated": "",
"owner": "",
"validated": true,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 880, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 880, "pagingCounter": 1, "nextPage": 2 }, "auths": [ { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth1)]
Auth1
object (Auth1)
- Example
- { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" }
_id
string
record
string
__v
int
i32
bank
object (bank)
- Example
- { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }
colors
object (colors)
- Example
- { "primary": "", "accent": "", "button": "" }
primary
string
accent
string
button
string
icon
string
logo
string
name
string
status
string
v2_icon
string
v2_logo
string
created_at
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
env
string
last_updated
string
owner
string
validated
boolean
id
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "11151"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"2b8f-r1PFmKnDHVgTTmj9U9STIbKuRC4\""
Date
string
- Content Type
- text/plain
- Example
- "Fri, 20 Nov 2020 12:05:40 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get Auth by date
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances within a specified date range.
from
string
Use this parameter to return auth records that were created after this date. The value should follow the standard YYYY-MM-DD ISO-8601 format.
- Example
- "2023-05-01"
to
string
Use this parameter to return auth records that were created before this date. The value should follow the standard YYYY-MM-DD ISO-8601 format.
- Example
- "2023-05-30"
page
int
i32
Return a specific page of results. For example, if you set limit to 20 and set page to 1, the API will return the first page, with 20 results in the response.
- Example
- "1"
limit
int
i32
Limit the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
- Example
- "10"
bearer
Request
{
"from": "2023-05-01",
"to": "2023-05-30",
"page": "1",
"limit": "10"
}Response
OK
{
"status": "success",
"message": "Auth retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 2306,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 2306,
"pagingCounter": 1,
"nextPage": 2
},
"auths": [
{
"_id": "",
"record": "",
"__v": 0,
"bank": {
"colors": {
"primary": "",
"accent": "",
"bg": "",
"button": ""
},
"icon": "",
"logo": "",
"name": "",
"status": "",
"v2_icon": "",
"v2_logo": ""
},
"created_at": "",
"customer": {
"_id": "",
"name": ""
},
"env": "",
"last_updated": "",
"owner": "",
"validated": true,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 2306, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 2306, "pagingCounter": 1, "nextPage": 2 }, "auths": [ { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "bg": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth2)]
Auth2
object (Auth2)
- Example
- { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "bg": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" }
_id
string
record
string
__v
int
i32
bank
object (bank)
- Example
- { "colors": { "primary": "", "accent": "", "bg": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }
colors
object (colors)
- Example
- { "primary": "", "accent": "", "bg": "", "button": "" }
primary
string
accent
string
bg
string
button
string
icon
string
logo
string
name
string
status
string
v2_icon
string
v2_logo
string
created_at
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
env
string
last_updated
string
owner
string
validated
boolean
id
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "26968"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"6958-XGlxFZBmVmup30enb5uf1B0noEM\""
Date
string
- Content Type
- text/plain
- Example
- "Fri, 20 Nov 2020 12:12:02 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get Auth by bank
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances using the bank Id
bank
string
The unique ID of a bank. Visit Okra's Coverage page for the list of bank IDs.
page
int
i32
Return a specific page of results. For example, if you set limit to 20 and set page to 1, the API will return the first page, with 20 results in the response.
limit
int
i32
Limit the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
bearer
Request
{
"bank": "// bank id",
"page": 1,
"limit": 1
}Response
OK
{
"status": "success",
"message": "Auth retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 1078,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 1078,
"pagingCounter": 1,
"nextPage": 2
},
"auths": [
{
"_id": "",
"record": "",
"__v": 0,
"bank": {
"icon": "",
"logo": "",
"name": "",
"status": "",
"v2_icon": "",
"v2_logo": ""
},
"created_at": "",
"customer": {
"_id": "",
"name": ""
},
"env": "",
"last_updated": "",
"owner": "",
"validated": true,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 1078, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 1078, "pagingCounter": 1, "nextPage": 2 }, "auths": [ { "_id": "", "record": "", "__v": 0, "bank": { "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth)]
Auth
object (Auth)
- Example
- { "_id": "", "record": "", "__v": 0, "bank": { "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" }
_id
string
record
string
__v
int
i32
bank
object (bank)
icon
string
A URL that points to the bank's icon.
logo
string
A URL that points to the bank's logo.
name
string
The bank's name.
slug
string
The bank's name in slug format.
status
string
The current connection status of the bank.
- Enum
-
- down
- degraded
- healthy
- dead
v2_icon
string
A URL that points to the bank's icon.
v2_logo
string
A URL that points to the bank's logo.
created_at
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
env
string
last_updated
string
owner
string
validated
boolean
id
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "11084"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"2b4c-weag7rS1dOXLjYDTUfrT9zmnWnc\""
Date
string
- Content Type
- text/plain
- Example
- "Fri, 20 Nov 2020 12:18:46 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Get Auth by customer date
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances within a specified date range.
from
string
Use this parameter to return auth records that were created after this date. The value should follow the standard YYYY-MM-DD ISO-8601 format.
- Example
- "2023-05-01"
to
string
Use this parameter to return auth records that were created before this date. The value should follow the standard YYYY-MM-DD ISO-8601 format.
- Example
- "2023-05-30"
customer
string
The unique ID of a customer.
- Example
- "140afb3ddecee700130acbc4"
page
int
i32
Return a specific page of results. For example, if you set limit to 20 and set page to 1, the API will return the first page, with 20 results in the response.
- Example
- "1"
limit
int
i32
Limit the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
- Example
- "10"
bearer
Request
{
"from": "2020-04-25",
"to": "2020-06-29",
"customer": "// customer ID",
"page": 1,
"limit": 10
}Response
OK
{
"status": "success",
"message": "Auth retrieved succesfully",
"data": {
"pagination": {
"totalDocs": 358,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 358,
"pagingCounter": 1,
"nextPage": 2
},
"auths": [
{
"_id": "",
"record": "",
"__v": 0,
"bank": {
"colors": {
"primary": "",
"accent": "",
"button": ""
},
"icon": "",
"logo": "",
"name": "",
"status": "",
"v2_icon": "",
"v2_logo": ""
},
"created_at": "",
"customer": {
"_id": "",
"name": ""
},
"env": "",
"last_updated": "",
"owner": "",
"validated": true,
"id": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "pagination": { "totalDocs": 880, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 880, "pagingCounter": 1, "nextPage": 2 }, "auths": [ { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" } ] }
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth1)]
Auth1
object (Auth1)
- Example
- { "_id": "", "record": "", "__v": 0, "bank": { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }, "created_at": "", "customer": { "_id": "", "name": "" }, "env": "", "last_updated": "", "owner": "", "validated": true, "id": "" }
_id
string
record
string
__v
int
i32
bank
object (bank)
- Example
- { "colors": { "primary": "", "accent": "", "button": "" }, "icon": "", "logo": "", "name": "", "status": "", "v2_icon": "", "v2_logo": "" }
colors
object (colors)
- Example
- { "primary": "", "accent": "", "button": "" }
primary
string
accent
string
button
string
icon
string
logo
string
name
string
status
string
v2_icon
string
v2_logo
string
created_at
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
env
string
last_updated
string
owner
string
validated
boolean
id
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "11151"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"2b8f-rnfJdmjXqcg90NLjatGFuQ2VY9g\""
Date
string
- Content Type
- text/plain
- Example
- "Fri, 20 Nov 2020 12:22:50 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Fetch Auths
This endpoint allows you retrieve the bank account associated with a record's current, savings, and domiciliary accounts, along with high-level account data and balances.
page
int
i32
Return a specific page of results. For example, if you set limit to 20 and set page to 1, the API will return the first page, with 20 results in the response.
- Example
- "1"
limit
int
i32
Limit the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
- Example
- "10"
bearer
Request
{
"page": "1",
"limit": "10"
}Response
OK
{
"status": "success",
"message": "Auths successfully retrieved",
"data": {
"total": 645,
"pagination": {
"totalDocs": 645,
"limit": 1,
"hasPrevPage": false,
"hasNextPage": true,
"page": 1,
"totalPages": 645,
"pagingCounter": 1,
"nextPage": 2
},
"auths": [
{
"id": "",
"validated": true,
"record": {
"_id": "",
"bank": {
"_id": "",
"name": ""
},
"env": "",
"owner": {
"_id": "",
"name": "",
"app_name": ""
},
"customer": {
"_id": "",
"name": ""
}
},
"created_at": "",
"last_updated": ""
}
]
}
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
status
string
message
string
data
object (data)
- Example
- { "total": 645, "pagination": { "totalDocs": 645, "limit": 1, "hasPrevPage": false, "hasNextPage": true, "page": 1, "totalPages": 645, "pagingCounter": 1, "nextPage": 2 }, "auths": [ { "id": "", "validated": true, "record": { "_id": "", "bank": { "_id": "", "name": "" }, "env": "", "owner": { "_id": "", "name": "", "app_name": "" }, "customer": { "_id": "", "name": "" } }, "created_at": "", "last_updated": "" } ] }
total
int
i32
pagination
object (pagination)
totalDocs
int
i32
The total number of results that match the request.
limit
int
i32
Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.
hasPrevPage
boolean
Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.
hasNextPage
boolean
Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.
page
int
i32
Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.
totalPages
int
i32
The total number of pages that the API returns.
pagingCounter
int
i32
The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.
prevPage
string or null
The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.
nextPage
string or null
The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
auths
array[object (Auth5)]
Auth5
object (Auth5)
- Example
- { "id": "", "validated": true, "record": { "_id": "", "bank": { "_id": "", "name": "" }, "env": "", "owner": { "_id": "", "name": "", "app_name": "" }, "customer": { "_id": "", "name": "" } }, "created_at": "", "last_updated": "" }
id
string
validated
boolean
record
object (record)
- Example
- { "_id": "", "bank": { "_id": "", "name": "" }, "env": "", "owner": { "_id": "", "name": "", "app_name": "" }, "customer": { "_id": "", "name": "" } }
_id
string
The unique identifier created by Okra used to reference the record.
env
string
The environment variable. Could either be:
- production
- sandbox.
owner
object (owner)
- Example
- { "_id": "", "name": "", "app_name": "" }
_id
string
name
string
app_name
string
customer
object (customer)
_id
string
The unique identifier that references the user.
name
string
The user’s full name.
created_at
string
last_updated
string
X-Powered-By
string
- Content Type
- text/plain
- Example
- "Express"
Access-Control-Allow-Methods
string
- Content Type
- text/plain
- Example
- "GET, POST, OPTIONS, PUT, PATCH, DELETE"
Access-Control-Allow-Headers
string
- Content Type
- text/plain
- Example
- "X-Requested-With,content-type,authorization"
Access-Control-Allow-Credentials
string
- Content Type
- text/plain
- Example
- "true"
Content-Length
string
- Content Type
- text/plain
- Example
- "668"
ETag
string
- Content Type
- text/plain
- Example
- "W/\"29c-WmE6C25k2IsKUp7KIVSShATRffk\""
Date
string
- Content Type
- text/plain
- Example
- "Tue, 03 Nov 2020 12:52:54 GMT"
Connection
string
- Content Type
- text/plain
- Example
- "keep-alive"
Keep-Alive
string
- Content Type
- text/plain
- Example
- "timeout=5"
Was this page helpful?