Get a Party
Contract preview: Public API hostnames are not live yet; this operation is not currently runnable. Returns the calling Integration’s current Party representation, never the merged operational Party.
Authorizations
Integration-owned environment-specific API key. Never paste a production key into documentation tools.
Path Parameters
Stable non-sensitive Client code authorized by the Integration grant.
^[A-Za-z0-9_-]{1,128}$Caller-assigned, opaque identifier for this Party's source-system record. It is stable when Party details change and is never a PayPathIQ ID, member or account number, or contact detail.
^[A-Za-z0-9_-]{1,128}$Response
Current Party representation.
- Option 1
- Option 2
"person"Caller-assigned, opaque identifier for this Party's source-system record. It is not a PayPathIQ ID, customer or member number, loan or account number, or contact detail. Keep it stable when Party details change.
^[A-Za-z0-9_-]{1,128}$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$1 - 200At most one address may be primary.
3At most one email may be primary.
5At most one phone number may be primary.
5At most one assertion per type; ordering is semantically irrelevant.
5- Option 1
- Option 2