Create guarantor

Beta

POST

/api/guarantors/v1/:encounter_id

Creates a new guarantor and returns the newly created Guarantor object.

Path parameters

encounter_idUUIDRequired

Request

This endpoint expects an object.

external_idstringRequired

first_namestringRequired

last_namestringRequired

addressobjectOptional

date_of_birthdateOptional

emailstringOptional

email_consentbooleanOptional

Defaults to false

phone_consentbooleanOptional

Defaults to false

phone_numberslist of objectsOptional

Response

This endpoint returns an object.

email_consentboolean

external_idstring

first_namestring

guarantor_idUUID

last_namestring

phone_consentboolean

phone_numberslist of objects

addressobjectOptional

date_of_birthdateOptional

emailstringOptional

Errors

POST

1 curl -X POST https://api.joincandidhealth.com/api/guarantors/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "external_id": "string",
6   "first_name": "string",
7   "last_name": "string"
8 }'

1 {
2   "email_consent": true,
3   "external_id": "string",
4   "first_name": "string",
5   "guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6   "last_name": "string",
7   "phone_consent": true,
8   "phone_numbers": [
9     {
10       "number": "string",
11       "type": "Home"
12     }
13   ],
14   "address": {
15     "address1": "string",
16     "city": "string",
17     "state": "AA",
18     "zip_code": "string",
19     "address2": "string",
20     "zip_plus_four_code": "string"
21   },
22   "date_of_birth": "2023-01-01",
23   "email": "string"
24 }

Built with

1	curl -X POST https://api.joincandidhealth.com/api/guarantors/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"external_id": "string",
6	"first_name": "string",
7	"last_name": "string"
8	}'

1	{
2	"email_consent": true,
3	"external_id": "string",
4	"first_name": "string",
5	"guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6	"last_name": "string",
7	"phone_consent": true,
8	"phone_numbers": [
9	{
10	"number": "string",
11	"type": "Home"
12	}
13	],
14	"address": {
15	"address1": "string",
16	"city": "string",
17	"state": "AA",
18	"zip_code": "string",
19	"address2": "string",
20	"zip_plus_four_code": "string"
21	},
22	"date_of_birth": "2023-01-01",
23	"email": "string"
24	}