Important Parameters

Lynx APIs utilize the following key request parameters:

Parameter

Definition

clientOrgName

Identifies the client organization within the Lynx client hierarchy that is initiating the API request. The clientOrgName included in the request must match the client organization associated with the token included in the request header .

clientMemberId

Identifies a member uniquely within the context of a client organization. The clientMemberId is set by you during your Lynx program member enrollment (established through a POST to the enrollments/member endpoint).

productName

Identifies the product of interest . Pairing productNamealong with accountType uniquely resolves of the individual accounts of a member without having to transmit sensitive banking information.

accountType

Identifies the member account type of interest . There is a parent-child relationship between productName and accountType, where many accountType values may be associated with a single productName. Pairing productName along with accountType uniquely resolves of the individual accounts of a member without having to transmit sensitive banking information.