Update - 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:

Body Params application/json

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

Example

{
    "branch_name": "Jamshedpur"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

{
    "contact_id": "string",
    "ifsc": "string",
    "account_no": "string",
    "account_holder_name": "string",
    "bank_name": "string",
    "branch_name": "string",
    "tags": [
        "string"
    ],
    "account_type": "savings",
    "id": "stringst",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "updated_by": "string",
    "tenant_id": "string"
}