๐Ÿ“šGet Module Status of Customer

Provides visibility to all the modules created for a Customer on your Gathr Tenant.

Get Module Status of Customer

GET {{baseUrl}}/customers/:customer_id/modules

Path Parameters

NameTypeDescription

customer_id*

String

This is UUID for a specific Customer that gets generated and returned in the POST Create New Customer response.

Status Codes

200 - OK

Customer Modules

{
    "data": {
        "id": "{{customerId}}",
        "modules": {
            "bankAccounts": [
                "85097581-36af-4c7c-80ed-b24202878e32"
            ],
            "identityDocuments": [
                "606f486d-b523-4401-ade9-8acdc57927a4",
                "998c6418-ea66-4714-a517-202a25d238a2"
            ],
            "addressDocuments": [
                "c7042949-09d8-4427-8790-6e040210fb82"
            ],
            "accountVerifications": [
                "a4146234-9521-4466-acc2-675eca216c10"
            ]
        },
        "verified": 0,
        "verified_at": null
    }
}
404 - Not Found

Customer Not Found

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in customers"
    }
}

Last updated