Parties

5 operações em Quadra Core API 0.5.0.

GET/v1/parties

Search Parties

Parâmetros

Nome	Tipo	Detalhe
query	string, opcional	query
type	string, opcional	query
status	string, opcional	query
role	string, opcional	query
kyc_state	string, opcional	query
limit	integer	query
cursor	string, opcional	query

Respostas

Status	Corpo	Detalhe
200	PartySearchResponseOut	Resposta bem-sucedida
422	HTTPValidationError	Erro de validação

POST/v1/parties

Create a Party

Parâmetros

Nome	Tipo	Detalhe
Idempotency-Key	string	headerobrigatório

Corpo da requisição

PartyCreateRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.

Respostas

Status	Corpo	Detalhe
200	PartyResponseOut	Resposta bem-sucedida
422	HTTPValidationError	Erro de validação

GET/v1/parties/{party_id}

Get a Party

Parâmetros

Nome	Tipo	Detalhe
party_id	string	pathobrigatório

Respostas

Status	Corpo	Detalhe
200	PartyResponseOut	Resposta bem-sucedida
422	HTTPValidationError	Erro de validação

PATCH/v1/parties/{party_id}

Update a Party

Parâmetros

Nome	Tipo	Detalhe
party_id	string	pathobrigatório

Corpo da requisição

PartyPatchRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.

Respostas

Status	Corpo	Detalhe
200	PartyResponseOut	Resposta bem-sucedida
422	HTTPValidationError	Erro de validação

GET/v1/parties/{party_id}/kyc

Get a Party's KYC record

Full KYC view (LaaS-17): current record + state history + screening runs + flags, from one partition query. Parties that never submitted KYC get a view synthesized from the METADATA risk summary (200, not 404).

Parâmetros

Nome	Tipo	Detalhe
party_id	string	pathobrigatório

Respostas

Status	Corpo	Detalhe
200	PartyKycResponseOut	Resposta bem-sucedida
422	HTTPValidationError	Erro de validação

Esquemas

Os modelos que as operações acima aceitam e devolvem. Campos opcionais estão marcados como tal; um campo tipado como outro modelo está documentado sob o nome dele.

Address

Campo	Tipo	Detalhe
city	string	obrigatório
country	string	obrigatório
line1	string	obrigatório
line2	string, opcional
postal_code	string, opcional
state	string, opcional
type	string	obrigatório

Contact

Campo	Tipo	Detalhe
is_primary	boolean	Padrão `false`
type	string	obrigatório
value	string	obrigatório

ExternalId

Campo	Tipo	Detalhe
key	string	obrigatório
system	string	obrigatório
value	string	obrigatório

HTTPValidationError

Campo	Tipo	Detalhe
detail	array de ValidationError

KycFlagOut

Campo	Tipo	Detalhe
added_at	string, opcional
added_by	string, opcional
flag_id	string	obrigatório
reason	string, opcional
resolved_at	string, opcional
resolved_by	string, opcional
source	string	obrigatório
source_ref	string, opcional

KycScreeningOut

Campo	Tipo	Detalhe
checked_lists	array de string
created_at	string, opcional
hits	array de object
provider_id	string, opcional
provider_report_ref	string, opcional
result	string	obrigatório
screening_id	string	obrigatório
trigger	string, opcional
verdict_digest	string, opcional

KycStateHistoryEntry

Campo	Tipo	Detalhe
actor	string	obrigatório
actor_type	string	obrigatório
at	string	obrigatório
from_state	string	obrigatório
provider_ref	string, opcional
reason	string, opcional
to_state	string	obrigatório

PartyAuditOut

Audit fields for party resources.

Campo	Tipo	Detalhe
created_at	string, opcional
created_by	string, opcional
updated_at	string, opcional
version	integer, opcional

PartyCreateRequest

Campo	Tipo	Detalhe
addresses	array de Address
contacts	array de Contact
country	string	obrigatório
display_name	string	obrigatório
external_ids	array de ExternalId
labels	array de string
legal_name	string, opcional
metadata	object, opcional
roles	array de string
tax_id	TaxId, opcional
type	"individual" \| "company"	obrigatório

PartyKycResponseOut

Campo	Tipo	Detalhe
document_refs	array de object
flags	array de KycFlagOut
kyc_level	integer	Padrão `0`
kyc_state	string	obrigatório
last_screened_at	string, opcional
party_id	string	obrigatório
provider_id	string, opcional
provider_report_ref	string, opcional
provider_session_ref	string, opcional
rescreen_due_at	string, opcional
rescreen_reason	string, opcional
screening_state	string	obrigatório
screenings	array de KycScreeningOut
state_history	array de KycStateHistoryEntry
verdict_digest	string, opcional

PartyPatchRequest

Campo	Tipo	Detalhe
address	Address, opcional
addresses	array de Address, opcional
contacts	array de Contact, opcional
country	string, opcional
display_name	string, opcional
external_ids	array de ExternalId, opcional
labels	array de string, opcional
legal_name	string, opcional
metadata	object, opcional
roles	array de string, opcional
status	string, opcional
tax_id	TaxId, opcional

PartyResponseOut

Party resource as returned by the API.

Campo	Tipo	Detalhe
addresses	array de não declarado	Padrão `[]`
audit	PartyAuditOut, opcional
contacts	array de não declarado	Padrão `[]`
country	string	obrigatório
created_at	string, opcional
created_by	string, opcional
display_name	string	obrigatório
external_ids	array de não declarado	Padrão `[]`
labels	array de string	Padrão `[]`
legal_name	string, opcional
metadata	object, opcional
party_id	string	obrigatório
rescreen_due_at	string, opcional
rescreen_reason	string, opcional
risk	object, opcional
roles	array de string	Padrão `[]`
status	string, opcional
type	"individual" \| "company"	obrigatório
updated_at	string, opcional
version	integer, opcional

PartySearchItemOut

Single party item in search results.

Campo	Tipo	Detalhe
country	string, opcional
display_name	string, opcional
kyc_state	string, opcional
party_id	string	obrigatório
status	string, opcional
summary	PartySearchSummaryOut, opcional
type	string, opcional

PartySearchResponseOut

Paginated list of parties.

Campo	Tipo	Detalhe
data	array de PartySearchItemOut	obrigatório
next_cursor	string, opcional

TaxId

Campo	Tipo	Detalhe
country	string	obrigatório
type	string	obrigatório
value	string	obrigatório

ValidationError

Campo	Tipo	Detalhe
ctx	object
input	não declarado
loc	array de string ou integer	obrigatório
msg	string	obrigatório
type	string	obrigatório

← Quadra Core API Chamar no playground →