Add Testing Customer

POST /aggregation/v1/customers/testing

Enroll a testing customer. A testing customer may only register accounts with FinBank institutions.

JSON Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
Accept HTTP Header application/json
username JSON Field The customer’s username, assigned by the partner (a unique identifier), following these rules:

  • minimum 6 characters
  • maximum 255 characters
  • any mix of uppercase, lowercase, numeric, and non-alphabet special characters ! @ . # $ % & * _ – +
  • the use of email in this field is discouraged
  • it is recommended to use a unique non-email identifier
  • Use of special characters may result in an error (e.g. í, ü, etc.)
firstName JSON Field The customer’s first name(s) / given name(s) (optional)
lastName JSON Field The customer’s last name(s) / surname(s) (optional)

Success: HTTP 201 (Created)

Example Request:

POST https://api.finicity.com/aggregation/v1/customers/testing
{
  "username": "USERNAME",
  "firstName": "FIRST_NAME",
  "lastName": "LAST_NAME"
}

Using Curl:

curl -v -H "Finicity-App-Key:APP_KEY" -H "Finicity-App-Token:ACCESS_TOKEN" -H "Content-Type:application/json" -H "Accept:application/json" -X POST "https://api.finicity.com/aggregation/v1/customers/testing""" -d '{ "username": "USERNAME", "firstName": "FIRST_NAME", "lastName": "LAST_NAME" }'

Response Details:

Field Name Description
id The ID of the new customer record
createdDate A timestamp of when the customer was added (see Handling Dates and Times)

Example Response:

{
   "id": "41442",
   "createdDate": "1412792539"
}

XML Implementation

Request Details:

Parameter Type Description
Finicity-App-Key HTTP Header Finicity-App-Key from Developer Portal
Content-Type HTTP Header application/json
Accept HTTP Header application/json
username XML Element The customer’s username, assigned by the partner (a unique identifier), following these rules:

  • minimum 6 characters
  • maximum 255 characters
  • any mix of uppercase, lowercase, numeric, and non-alphabet special characters ! @ . # $ % & * _ – +
  • the use of email in this field is discouraged
  • it is recommended to use a unique non-email identifier
  • Use of special characters may result in an error (e.g. í, ü, etc.)
firstName XML Element The customer’s first name(s) / given name(s) (optional)
lastName XML Element The customer’s last name(s) / surname(s) (optional)

Success: HTTP 201 (Created)

Example Request:

POST https://api.finicity.com/aggregation/v1/customers/testing
<customer>
  <username>USERNAME</username>
  <firstName>FIRST_NAME</firstName>
  <lastName>LAST_NAME</lastName>
</customer>

Using Curl:

curl -v -H "Finicity-App-Key:APP_KEY" -H "Finicity-App-Token:ACCESS_TOKEN" -H "Content-Type:application/xml" -H "Accept:application/xml" -X POST "https://api.finicity.com/aggregation/v1/customers/testing""" -d '<customer> <username>USERNAME</username> <firstName>FIRST_NAME</firstName> <lastName>LAST_NAME</lastName> </customer>'

Response Details:

Field Name Description
customer Root element
id The ID of the new customer record
createdDate A timestamp of when the customer was added (see Handling Dates and Times)

Example Response:

<customer>
  <id>41442</id>
  <createdDate>1412792539</createdDate>
</customer>