Deprecated

Get guarantor

GET

/api/guarantors/v1/:guarantor_id

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.guarantor.v_1.get(
10     guarantor_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Play

200Retrieved

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 }

Retrieves a guarantor by its guarantor_id.

Path parameters

guarantor_idUUIDRequired

Response

This endpoint returns an object.

addressobject

email_consentboolean

external_idstring

first_namestring

guarantor_idUUID

last_namestring

phone_consentboolean

phone_numberslist of objects

date_of_birthdateOptional

emailstringOptional

Path parameters

Headers

Response