Get Business Representatives

Read for details on retrieving business representatives

Get a business representative's details

GET /users/{{user_id}}/business-representative/{{id}}

Request Sample

curl --location --request GET '{{url}}/users/{{user_id}}/business-representative/{{id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '' 

Response Sample

{
    "address_line1": "123 Main Street Room 22",
    "city": "North Pole",
    "date_of_birth": "1997-09-08",
    "email":"[email protected]",
    "first_name": "John",
    "gender":"male",
    "id": {{UUID}},
    "last_name": "Sherpa",
    "mobile_phone":"5417543010",
    "ownership_percentage":0,
    "physical_documents": [
        {
            "country": "US",
            "expiry_date": "2023-11-11",
            "id":{{UUID}},
            "state": "CA",
            "document_type": "PASSPORT",
        }
    ],
    "state": "CA",
    "title":"CEO",
    "virtual_documents": [
        {
            "country": "US",
            "document_value": "*****1111",
            "id": {{UUID}},
            "state": "CA",
            "document_type": "SSN",
            "id_issuing_authority": "POTUS",
            "issue_date": "2018-01-01"
        }
    ],
    "zipcode": "99705",
    "br_type": {
        "account_operator": true,
        "beneficial_owner": false,
        "compliance": false,
        "primary_controller": false
    },
    "country": "US",
}

Get list of all business representative

GET /users/{{user_id}}/business-representative

Request Sample

curl --location --request GET '{{url}}/users/{{user_id}}/business-representative' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Sample

[
    {
        "address_line1": "500 8 El Camino Real Santa Clara",
        "city": "CA",
        "date_of_birth": "1997-09-08",
        "email": "[email protected]",
        "first_name": "John",
        "gender": "male",
        "id": {{UUID}},
        "last_name": "Sherpa",
        "mobile_phone": "5417543010",
        "ownership_percentage": 0,
        "physical_documents": [
            {
                "country": "US",
                "expiry_date": "2023-11-11",
                "id":{{UUID}},
                "state": "CA",
                "document_type": "PASSPORT",
            }
        ],
        "state": "CA",
        "title": "CEO",
        "virtual_documents": [
            {
                "country": "US",
                "document_value": "*****1111",
                "id": {{UUID}},
                "state": "CA",
                "document_type": "SSN",
                "id_issuing_authority": "POTUS",
                "issue_date": "2018-01-01"
            }
        ],
        "zipcode": "99705",
        "br_type": {
            "account_operator": true,
            "beneficial_owner": false,
            "compliance": false,
            "primary_controller": false
        },
        "country": "US"
    },
    {
        "address_line1": "500 8 El Camino Real Santa Clara",
        "city": "CA",
        "date_of_birth": "1997-09-08",
        "email": "[email protected]",
        "first_name": "Jane",
        "gender": "female",
        "id": {{UUID}},
        "last_name": "Sherpa",
        "mobile_phone": "5417543010",
        "ownership_percentage": 0,
        "physical_documents": [
            {
                "country": "US",
                "expiry_date": "2023-11-11",
                "id": "69313afa-3e27-4adc-a0f0-e750b95152f3",
                "state": "CA",
                "document_type": "PASSPORT"
            }
        ],
        "state": "CA",
        "title": "CEO",
        "virtual_documents": [
            {
                "country": "US",
                "document_value": "*****2222",
                "id": "6f0ff320-5062-41fd-86f7-4242b52f52e8",
                "state": "CA",
                "document_type": "SSN",
                "id_issuing_authority": "POTUS",
                "issue_date": "2018-10-01"
            }
        ],
        "zipcode": "95053",
        "br_type": {
            "account_operator": true,
            "beneficial_owner": false,
            "compliance": false,
            "primary_controller": false
        },
        "country": "US"
    }
]