Documentation

Get User by Bank Account

This API will return the details of the user associated with a specific bank account


Endpoint

   /3p/api/v1/bank-account/user

 

Request Payload

{
    "bank_account": {
        "uuid": "9c2b23cc-5692-4f54-aff2-254960e85992",
        "aggregator_type": "bank_link"
    }
}

FieldsTypeIs RequiredDescription
bank_account.uuidstringyesBank Account UUID
bank_account.aggregator_typestringyesBank account aggregator type

Possible values:
plaid
manual
bank_link

Response Object

{
    "status": true,
    "message": "",
    "data": {
        "client_reference_id": "",
        "uuid": "401c79dd-d38c-4c3a-8edf-1afac5914d2d",
        "first_name": null,
        "last_name": null,
        "name": "Jack Inc.",
        "tin": "961862955",
        "user_status": "Approved|On Hold|Rejected",
        "kyb_status": "Approved|In Review|Failed|null",
        "email": null,
        "phone": null,
        "financing_credit_balance": null,
        "address": {
            "street_address": "20 Elmora Ave",
            "additional_address": "",
            "city": "Elizabeth",
            "state": "NJ",
            "country": "US",
            "zip": "07202"
        },
        "business_owners": [
            {
                "first_name": "Olive",
                "last_name": "Vein",
                "dob": "1996-05-04",
                "ssn9": "123456789",
                "address_line_1": "778 E Encore Dr",
                "city": "Hanford",
                "state": "CA",
                "zip": "93230"
            }
        ],
        "created_at": "2023-06-10 14:15:54",
        "updated_at": "2023-06-10 14:15:54"
    },
    "errors": []
}
{
    "status": true,
    "message": "",
    "data": {
        "client_reference_id": "",
        "uuid": "401c79dd-d38c-4c3a-8edf-1afac5914d2d",
        "status": "Approved|On Hold|Rejected",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": null,
        "phone": null,
        "address": {
            "street_address": "20 Elmora Ave",
            "additional_address": "",
            "city": "Elizabeth",
            "state": "NJ",
            "country": "US",
            "zip": "07202"
        },
        "created_at": "2023-06-10 14:15:54",
        "updated_at": "2023-06-10 14:15:54",
        "role": "person"
    },
    "errors": []
}