Retrieve - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

contact_bank_id

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

contact_id

string

required

ifsc

string

optional

IFSC code, 4 letters followed by 7 digits.

Match pattern:

^[A-Za-z]{4}[0-9]{7}$

account_no

string

optional

Account number, between 9 and 18 digits.

Match pattern:

^[0-9]{9,18}$

account_holder_name

string

optional

Account holder's name, 1-100 characters long, allowing letters, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z\s.\-'&()]{1,100}$

bank_name

string

optional

Bank name, 1-100 characters long, allowing letters, numbers, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z0-9\s,.\-'&()]{1,100}$

branch_name

string

optional

Branch name, 1-100 characters long, allowing letters, numbers, spaces, and common symbols (,.'-&()).

>= 1 characters<= 100 characters

Match pattern:

^[a-zA-Z0-9\s,.\-'&()]{1,100}$

tags

array[string]

optional

An array of unique tags.

account_type

enum<string>

optional

Account type. Allowed values are 'savings', 'current', 'joint', or 'business'.

Allowed values:

savingscurrentjointbusiness

id

string

optional

ID, 8-40 characters long, allowing alphanumeric characters.

>= 8 characters<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

created_at

string <date-time>

optional

Timestamp indicating when the entity was created, in ISO 8601 format.

created_by

string

optional

Created by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

updated_at

string <date-time>

optional

Timestamp indicating when the entity was last updated, in ISO 8601 format.

updated_by

string | null

optional

Updated by, 1-100 characters long, allowing alphanumeric characters, spaces, periods, underscores, and dashes.

<= 100 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

tenant_id

string

optional

Tenant ID, 6-40 characters long, allowing alphanumeric characters.

<= 40 characters

Match pattern:

^[a-zA-Z0-9._-]{8,50}$

Example

{"id":"01JMHMF5R3PPZDV8MB25PXKARZ","tenant_id":"59ecf94e-054d-43ee-83db-b158ab9d7f67","created_by":"cffe818a-5003-4116-9104-069f7e062bb4","updated_by":"","created_at":"2025-02-20T17:44:09.218207Z","updated_at":"2025-02-20T17:44:09.218207Z","account_type":"savings","ifsc":"UBIN0568627","account_no":"686202010000080","account_holder_name":"Karan Kumar","bank_name":"Union Bank of India","branch_name":"Chennai","tags":null,"contact":"01JMHF8CDTD8Z5KAMYXEZEQGHX"}