Update guarantor | Candid

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

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 "auto_charge_consent": true, 11 "email_consent": true, 12 "external_id": "external_id", 13 "first_name": "first_name", 14 "guarantor_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 15 "last_name": "last_name", 16 "phone_consent": true, 17 "phone_numbers": [ 18 { 19 "number": "number", 20 "type": "Home" 21 }, 22 { 23 "number": "number", 24 "type": "Home" 25 } 26 ], 27 "date_of_birth": "2023-01-15", 28 "email": "email" 29 }

Updates a guarantor by its guarantor_id.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path Parameters

guarantor_idUUIDRequired

Request

This endpoint expects an object.

first_namestringOptional

last_namestringOptional

external_idstringOptional

A unique identifier for the guarantor assigned by an external system.

date_of_birthdateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-25.

addressobjectOptional

phone_numberslist of objectsOptional

phone_consentbooleanOptional

emailstringOptional

email_consentbooleanOptional

auto_charge_consentbooleanOptional

Response

This endpoint returns an object.

addressobject

auto_charge_consentboolean

email_consentboolean

external_idstring

first_namestring

guarantor_idUUID

last_namestring

phone_consentboolean

phone_numberslist of objects

date_of_birthdate or null

emailstring or null