Endpoints

Consumer APIs

Create Consumer

Create a consumer by their consumer_id.

POST: https://sandbox-api.upwardli.com/v2/consumer/

Minimum Request Body

1{
2    "pcid": "12345678"
3}

Request body with optional fields

1{
2    "pcid": "12345678",
3    "first_name": "Test",
4    "last_name": "User",
5    "email": "testing.account@mailinator.com",
6    "phone_number": "+14256184684",
7    "date_of_birth": "1986-03-12",
8    "address_line1": "12345 Main Street",
9    "address_city": "Cityname",
10    "address_state": "ST",
11    "address_zip": "980050000"
12}

Sample Response Body

1{
2    "id": "00000000-0000-0000-0000-000000000000",
3    "pcid": "12345678",
4    "first_name": null,
5    "last_name": null,
6    "email": null,
7    "is_active": true,
8    "kyc_status": "NotStarted",
9    "phone_number": null,
10    "date_of_birth": null,
11    "tax_id_type": null,
12    "tax_identifier": null,
13    "address_line1": null,
14    "address_line2": null
15}

Get Consumer

Get a consumer by their consumer_id.

GET: https://sandbox-api.upwardli.com/v2/consumer/{consumer_id}/

Sample Response Body

1{
2    "id": "{consumer_id}",
3    "pcid": "12345678",
4    "first_name": "John",
5    "last_name": "Doe",
6    "email": "john.doe@gmail.com",
7    "is_active": true,
8    "kyc_status": "Complete",
9    "phone_number": "+12065559034",
10    "date_of_birth": "2000-01-01",
11    "tax_id_type": "SSN",
12    "tax_identifier": "***-**-1234",
13    "address_line1": "100 Main Street",
14    "address_line2": null
15}

Get Consumer by their Partner Consumer ID

Get a consumer by their pcid. The pcid is the id that you provided to us during as the pcid property when they first went through onboarding.

GET: https://sandbox-api.upwardli.com/v2/consumer/pcid/{pcid}/

Sample Response Body

1{
2    "id": "75ebdd35-7e8d-4ced-9bf6-14e528d8f7e9", 
3    "pcid": "{pcid}",
4    "first_name": "John",
5    "last_name": "Doe",
6    "email": "john.doe@gmail.com",
7    "is_active": true,
8    "kyc_status": "Complete",
9    "phone_number": "+12065559034",
10    "date_of_birth": "2000-01-01",
11    "tax_id_type": "SSN",
12    "tax_identifier": "***-**-1234",
13    "address_line1": "100 Main Street",
14    "address_line2": null
15}

Cancel Account

Cancel a consumer account.

This is meant only to be used when the user is not able to go through the profile close account flow.

POST: https://api-sandbox.upwardli.com/v2/consumer/{customer_external_id}/cancel-account/

Sample Response Body

{
    "success": true
}
Built with