Get guarantor | Candid | API Reference

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 )

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

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

auto_charge_consentboolean or null

date_of_birthdate or null

emailstring or null

Path parameters

Headers

Response