Get Onboarding

1 import requests 2 3 url = "https://host.com/v2/onboarding/external_id/" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "string", 3 "status": "string", 4 "consumer": { 5 "id": "string", 6 "pcid": "string", 7 "mla_status": true, 8 "phone_number": "string", 9 "date_of_birth": "string", 10 "tax_id_type": "string", 11 "address_line1": "string", 12 "address_line2": "string", 13 "address_city": "string", 14 "address_state": "string", 15 "address_zip": "string", 16 "external_id": "string", 17 "first_name": "string", 18 "last_name": "string", 19 "email": "string", 20 "is_active": true, 21 "kyc_status": "string", 22 "tax_identifier": "string", 23 "credit_lines": "string" 24 }, 25 "kyc": { 26 "inquiry_ids": [ 27 "string" 28 ], 29 "fallback_inquiry_id": "string", 30 "inquiry_template_id": "string" 31 }, 32 "e_sign": { 33 "agreement_accepted": true, 34 "agreement_accepted_date": "2024-01-15T09:30:00Z" 35 }, 36 "underwriting": { 37 "result": "string", 38 "data": "string", 39 "errors": [ 40 null 41 ] 42 }, 43 "product": { 44 "product_id": "string", 45 "product_configuration": {} 46 }, 47 "previous_steps": [ 48 { 49 "slug": "string", 50 "url": "string" 51 } 52 ], 53 "current_steps": [ 54 { 55 "slug": "string", 56 "url": "string" 57 } 58 ], 59 "metadata": {} 60 }

Get Partner from request
Get the Onboarding and check if it belongs to the partner
Return the onboarding id and consumer data

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

external_idstringRequired

Response

idstringformat: "uuid"

statusstring

consumerobject

kycobject

e_signobject

underwritingobject

productobject

previous_stepslist of objects

current_stepslist of objects or null

metadataobject or null