onboard/v1/customer/status

[GET] /onboard/v1/customer/status

Get customer status

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.

Example [GET] Request

{{avenu_base_url}}/onboard/v1/customer/status?newCustomerTag={{newCustomerTag}}

Query Parameter

Parameter	Format	Required	Possible Error Codes
"newCustomerTag"	String	Y	1001, 1002, 1003

Example Response

{
    "newCustomerTag": "",
    "customerAccountNumber": "",
    "status": "",
    "statusInfo": "",
}

Response Elements

Element	Meaning	Reference
newCustomerTag	The customer's new customer tag. This value is set in during onboarding prior to an account number being associated with the customer.
customerAccountNumber	The Avenu customer account number is returned only after onboarding finalization (status code: `ENABLED`)
status	The customer's status code.	See Below
statusInfo	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

accountStatus	customerAccountNumber	statusInfo	status
PENDING	null	Account is pending.	"PENDING"
DISABLED	null	Account is disabled. No payments can be made from/to this account.	"DISABLED"
ENABLED	set to SubLedger `customerAccounts`	Account is enabled	"ENABLED"
ID_SCAN	null	Customer needs to provide ID scan. `statusInfo` object contains the IDology KYC ID number	"ID_SCAN"

Response per Status

Condition	Response
CustomerAccount `accountStatus` = `PENDING`	`{ status: 'PENDING', customerAccountNumber: null, statusInfo: null }`
CustomerAccount `accountStatus` = `PENDING` AND `accountKyc` = `ID_SCAN`	`{ status: 'ID_SCAN', customerAccountNumber: null, statusInfo: [Idology KYC ID number] }`
CustomerAccount `accountStatus` = `SUSPENDED`	`{ status: 'DISABLED', customerAccountNumber: null, statusInfo: null }`
CustomerAccount `accountStatus` = `CLOSED`	`{ status: 'DISABLED', customerAccountNumber: null, statusInfo: null }`
CustomerAccount `accountStatus` = `OPEN`	`{ status: 'ENABLED', customerAccountNumber: [customerAccountNumber], statusInfo: null }`

Errors

code	Message
1001	"Missing required field"
1002	"Invalid data structure"
1003	"Invalid data"