The get customer status endpoint allows for the retrieval of the current status of a customer. After a customer is onboarded their data will pass through several KYC (know-your-customer) vendor systems aimed at preventing money laundering and fraud. The status endpoint will provide information based on the response of those checks, and if any additional identification verification is required.
The request allows the newCustomerTag parameter as a string. When provided, Avenu's API will query the Customer Account and Customer Sub-ledger Event to retrieve the Customer Account Status.
The customer's new customer tag. This value is set in during onboarding prior to an account number being associated with the customer.
The Avenu customer account number is returned only after onboarding finalization (status code: ENABLED)
The customer's status code.
Additional information associated with status code.
The status field will change depending on the value of accountStatus returned by the query. The following table illustrates possible response values and behavior. If a status of PENDING is returned, then the Avenu API is still awaiting a response from the KYC vendors and you should check back soon for an updated status.
Customer Status Codes
Account is pending.
Account is disabled. No payments can be made from/to this account.
set to SubLedger customerAccounts
Account is enabled
Customer needs to provide ID scan. statusInfo object contains the IDology KYC ID number