Create Account

POST

/api/v1/account

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

x-api-version

string

optional

Body Params application/json

first_name

string

required

middle_name

string

optional

last_name

string

required

mobile_number

string

required

string

required

dob

string

required

city

string

required

nationality

string

required

live_selfie

string

required

passport_front

string

required

passport_mrz_line1

string

required

passport_mrz_line2

string

required

passport_expiry_date

string

required

passport_issue_date

string

required

passport_number

string

required

residential_address_1

string

required

residential_address_2

string

optional

state

string

required

postal_code

string

required

country

string

required

consents

array [object {1}]

required

create_card

string

optional

Example

{
    "first_name": "Test",
    "middle_name": "New",
    "last_name": "Account",
    "mobile_number": "91-6374573878",
    "email": "testNewAccount@example.com",
    "dob": "1997-10-10",
    "city": "Syndey",
    "nationality": "AU",
    "live_selfie": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBiYWNrLnBuZ18xNzE5NTY0NDg0MzUy",
    "passport_front": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBmcm9udC5wbmdfMTcxOTU2NDQ4NDcwOA",
    "passport_mrz_line1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",
    "passport_mrz_line2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",
    "passport_expiry_date": "2027-09-08",
    "passport_issue_date": "2015-08-31",
    "passport_number": "P2251460",
    "residential_address_1": "200 Collins Street",
    "residential_address_2": "200 Collins Street",
    "state": "Sydney",
    "postal_code": "560102",
    "country": "AU",
    "consents": [
        {
            "create_card": "true"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-sandbox.z.inc/api/v1/account' \
--header 'x-api-version;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "Test",
    "middle_name": "New",
    "last_name": "Account",
    "mobile_number": "91-6374573878",
    "email": "testNewAccount@example.com",
    "dob": "1997-10-10",
    "city": "Syndey",
    "nationality": "AU",
    "live_selfie": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBiYWNrLnBuZ18xNzE5NTY0NDg0MzUy",
    "passport_front": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBmcm9udC5wbmdfMTcxOTU2NDQ4NDcwOA",
    "passport_mrz_line1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",
    "passport_mrz_line2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",
    "passport_expiry_date": "2027-09-08",
    "passport_issue_date": "2015-08-31",
    "passport_number": "P2251460",
    "residential_address_1": "200 Collins Street",
    "residential_address_2": "200 Collins Street",
    "state": "Sydney",
    "postal_code": "560102",
    "country": "AU",
    "consents": [
        {
            "create_card": "true"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "account_details": {
        "attachments": {
            "additional_files": []
        },
        "individual_details": {
            "account_usage": {
                "card_usage": [
                    "GENERAL_EXPENSES",
                    "EDUCATION",
                    "TRAVEL_TRANSPORT",
                    "BILLS_UTILITIES",
                    "INVESTMENT",
                    "SERVICES"
                ],
                "collection_country_codes": [
                    "IN",
                    "SG",
                    "US",
                    "AE"
                ],
                "collection_from": [
                    "ALLOWANCE_FROM_FAMILY",
                    "INVESTMENT_INCOME_NONPROPERTY",
                    "SAVINGS",
                    "OTHER_THIRD_PARTIES",
                    "PAYMENT_REFUNDS"
                ],
                "expected_monthly_transaction_volume": {
                    "amount": "500.0",
                    "currency": "USD"
                },
                "payout_country_codes": [
                    "IN",
                    "SG",
                    "US",
                    "AE"
                ],
                "payout_to": [
                    "CONNECTED_AWX_ACCOUNT",
                    "EDUCATIONAL_INSTITUTIONS",
                    "FRIENDS_OR_RELATIVES",
                    "OTHER_THIRD_PARTY_INDIVIDUALS",
                    "OWN_BANK_ACCOUNT"
                ],
                "product_reference": [
                    "CREATE_CARDS",
                    "MAKE_TRANSFERS",
                    "RECEIVE_TRANSFERS",
                    "TRADE_SECURITIES",
                    "TUITION_PAYMENTS"
                ]
            },
            "attachments": {
                "individual_documents": []
            },
            "date_of_birth": "1997-10-10",
            "employer": null,
            "estimated_monthly_income": null,
            "first_name": "Test",
            "first_name_english": null,
            "identifications": {
                "primary": {
                    "identification_type": "PASSPORT",
                    "issuing_country_code": "SG",
                    "passport": {
                        "effective_at": "2015-08-31",
                        "expire_at": "2027-09-08",
                        "front_file_id": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBmcm9udC5wbmdfMTcxOTU2NDQ4NDcwOA",
                        "mrz_line1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",
                        "mrz_line2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",
                        "number": "P2251460"
                    }
                }
            },
            "last_name": "Account",
            "last_name_english": null,
            "live_selfie_file_id": "MjMzYTZlNjktMTVmYy00NmUwLWI4NDUtZmJjMzM4ZTA1NDhkLHwsaG9uZ2tvbmcsfCxQYXNzcG9ydCBiYWNrLnBuZ18xNzE5NTY0NDg0MzUy",
            "middle_name": "New",
            "middle_name_english": null,
            "nationality": "SG",
            "occupation": null,
            "other_names": null,
            "phone_number": "91-6374573878",
            "photo_holding_identification_file_id": null,
            "residential_address": {
                "address_line1": "200 Collins Street",
                "address_line2": "200 Collins Street",
                "country_code": "AU",
                "postcode": "569933",
                "state": "Melbourne",
                "suburb": "Singapore"
            },
            "residential_address_english": {
                "country_code": "AU",
                "postcode": "569933"
            }
        },
        "business_details": null,
        "business_person_details": [],
        "legal_entity_id": "le_QilEAu_7OvOBErUz_p8s9Q",
        "legal_entity_identifier": null,
        "legal_entity_type": "INDIVIDUAL",
        "trustee_details": null
    },
    "created_at": "2024-07-25T07:23:41+0000",
    "customer_agreements": {
        "agreed_to_biometrics_consent": true,
        "agreed_to_data_usage": true,
        "agreed_to_terms_and_conditions": true
    },
    "id": "acct_NaMAQDd3N7ud803_OChkhg",
    "identifier": "testNewAccount@ex.ample.com",
    "nickname": "Test Account",
    "primary_contact": {
        "attachments": {
            "identity_files": []
        },
        "email": "testNewAccount@ex.ample.com",
        "mobile": "91-6374573878"
    },
    "status": "SUBMITTED",
    "view_type": "COMPLETE"
}

🟠404Record Not Found

Modified at 2024-07-28 15:02:39

Accounts

Get Account