The API utilizes HTTP Basic Authentication for access to the platform. Specific authorization is dictated by the unique ID provided during the transaction in the URL. These details are provided by the CU*Answers team during your integration.
Certain aspects of the API that relate to authentication, as well as identification within the core processing system require configuration for each partner. Some of these items will change for each CU you interact with, and will need to be provided with each transaction, some will be specific to you as a vendor/partner. In all cases this information will be provided by the CU*Answers Software Integrations team, or retrieved from certain API endpoints. If you have any questions on how to acquire this information, please contact us.
These items are configured at the partner level:
In order to interact with our API, you will see certain aspects in the sample documentation that are required to be different for each CU that you access. In all cases, this information will be provided by the CU*Answers Software Integrations team, or retrieved from certain API endpoints. If you have any questions on how to acquire this information, please contact us.
These items are configured at the CU level:
This function allows a member inquiry by SSN or account base. This inquiry will return a number of attributes, including account and loan information currently attached to the account.
More detail is available within the XML examples below
Important Note: Due to the sensitive nature of data being provided in this call, this is performed as a POST instead of a typical GET request. As these requests are stored (securely) in our system, your POST request will result in a 201 Created HTTP response, even though it's theoretically a GET process.
| Action | HTTP Verb | Entity | URI |
|---|---|---|---|
| Retrieve | POST | Member Search | /api/credit_unions/{CUID}/member_search |
Every verb is not supported for every entity. It is limited by permission and implementation, to be coordinated with your partner certification representative.
Retrieve account information about a member
| HTTP Verb | POST |
| Endpoint URI | /api/credit_unions/{CUID}/member_search |
| Available Request Content-Type(s) | application/xml |
| Request Body | View Schema View XML Sample (SSN) View XML Sample (Account) |
| Available Response Content-Type(s) | XML |
| Resonse Body | View Schema View XML Sample (SSN) View XML Sample (Account) |
| HTTP Response on Success | HTTP 201 Created |
The intent to retrieve member information is signified by the request type and URI. Each entity response will be provided in XML format per the referenced schemas
Note: These example do not have all header information. Much of the details must be coordinated. The request bodies’ format are for example purposes only.
Request from Vendor to CU*Answers
Response from CU*Answers
This is a closed API, which means in order to gain access, you have to reach out. Also, if you have any questions that aren't covered in this documentation, or maybe they are and you'd like clarification, please Contact Us