Deprecated

Create guarantor

POST

/api/guarantors/v1/:encounter_id

POST

1 import datetime
2 import uuid
3 
4 from candid import CandidApiClient
5 from candid.resources.commons import (
6     PhoneNumber,
7     PhoneNumberType,
8     State,
9     StreetAddressShortZip,
10 )
11 from candid.resources.guarantor.resources.v_1 import GuarantorCreate
12 
13 client = CandidApiClient(
14     client_id="YOUR_CLIENT_ID",
15     client_secret="YOUR_CLIENT_SECRET",
16 )
17 client.guarantor.v_1.create(
18     encounter_id=uuid.UUID(
19         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20     ),
21     request=GuarantorCreate(
22         phone_numbers=[
23             PhoneNumber(
24                 number="1234567890",
25                 type=PhoneNumberType.HOME,
26             )
27         ],
28         phone_consent=True,
29         email="johndoe@joincandidhealth.com",
30         email_consent=True,
31         first_name="string",
32         last_name="string",
33         external_id="string",
34         date_of_birth=datetime.date.fromisoformat(
35             "2023-01-15",
36         ),
37         address=StreetAddressShortZip(
38             address_1="123 Main St",
39             address_2="Apt 1",
40             city="New York",
41             state=State.NY,
42             zip_code="10001",
43             zip_plus_four_code="1234",
44         ),
45     ),
46 )

Play

200Successful

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

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

Path parameters

encounter_idUUIDRequired

Request

This endpoint expects an object.

addressobjectRequired

external_idstringRequired

first_namestringRequired

last_namestringRequired

date_of_birthdateOptional

emailstringOptional

email_consentbooleanOptional

Defaults to false

phone_consentbooleanOptional

Defaults to false

phone_numberslist of objectsOptional

Response

This endpoint returns an object.

addressobject

email_consentboolean

external_idstring

first_namestring

guarantor_idUUID

last_namestring

phone_consentboolean

phone_numberslist of objects