Objetos
CardList
Campos
expandedCardExpandedpermissionsObjectPermissionListaccessstringValores permitidos:
wholepartialaccess_contactstringA quem pedir acesso (só quando
access=partial).aclobjectCampos
verifybooleanobrigatóriowritebooleanobrigatório
categorystringobrigatóriocategory_confidencenumber | nullobrigatóriocategory_lockedbooleanobrigatóriocategory_reviewbooleanobrigatóriocollectionstringobrigatóriocollection_idintegerobrigatóriocollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullConteúdo do editor da última versão publicada. O campo pode estar ausente; nesse caso, obtenha o conteúdo do editor a partir de um rascunho (
POST /v1/draftscomcard_id).editing_lockEditingLock | nullBloqueio de edição ativo. O campo pode estar ausente; nesse caso, o editor descobre quem tem o bloqueio pelo
409 cards.lockedemPOST /v1/cards/{card_id}/lock.created_atstring (date-time)obrigatóriodays_since_verifiedintegerobrigatórioerrorstring | nullobrigatórioeventsarray of CardEventfeedback_negintegerobrigatóriofeedback_posintegerobrigatóriofoldersarray of CardFolderRefSó na lista de cartões: as pastas que contêm o cartão (as visíveis para o usuário), com os caminhos a partir da raiz da coleção. Uma lista vazia significa que o cartão não está em nenhuma pasta.
has_tablesbooleanSó na lista de cartões.
hidden_partsbooleanidstringobrigatóriojobJob | nullorg_idintegerobrigatórioowner_activeboolean | nullowner_idinteger | nullobrigatórioowner_namestring | nullobrigatóriopagesinteger | nullobrigatórioparserstring | nullobrigatórioAnalisador do documento como código neutro:
document(estrutura completa: páginas, títulos, tabelas, páginas digitalizadas),pdf(a camada de texto do PDF),docx,xlsx,csv,markdown,html,text. A lista pode crescer.sensitivebooleanobrigatóriosha256string | nullobrigatóriosizeintegerobrigatóriosnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanobrigatóriosource_pathstring | nullobrigatóriosource_urlstring | nullobrigatóriostatusstringobrigatórioValores permitidos:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringobrigatóriotitlestringobrigatóriotrustnumberobrigatóriotrust_if_verifiednumberupdated_atstring (date-time)obrigatórioverified_atstring (date-time) | nullobrigatórioverified_byinteger | nullobrigatórioverified_by_namestring | nullverifier_idsarray of integerobrigatórioverifiersarray of objectCampos
activebooleanobrigatórioidintegerobrigatórionamestringobrigatório
verify_interval_daysintegerobrigatórioversionintegerobrigatórioversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectConfigurações manuais da análise do documento (prévia).
doc_kindDocKind | nullTipo de documento.
nullse o tipo não foi determinado (por exemplo, nos cartões indexados antes da introdução dos tipos de documento).doc_kind_confidencenumber | nullGrau de certeza do tipo de documento, de 0 a 1.
doc_kind_sourcestring | nullO que determinou o tipo: regras (
rules), um usuário (manual) ou a classificação automática. A lista pode crescer: trate um valor desconhecido como classificação automática.Valores permitidos:
rulesmanualnullinvoiceDocInvoiceExtraction | nullCampos de uma fatura, nota de crédito ou recibo (só nesses tipos, e só no cartão, não na lista).
nullse você não tem acesso ao documento inteiro, porque os campos são extraídos do documento inteiro.warningsarray of ReviewWarningAvisos da análise do documento (
ReviewWarning; só no cartão, não na lista).enrichmentCardEnrichmentStatus | nullStatus do enriquecimento (só no cartão, não na lista). O tipo de documento, os campos da fatura e os registros financeiros são acrescentados em segundo plano após a indexação e podem ser recalculados depois; eles aparecem no cartão quando ficam prontos.
nullsignifica que não há status disponível (o cartão foi indexado sem enriquecimento em segundo plano).external_idstring | nullID do cartão no sistema do integrador. É único na organização entre os cartões que não vêm de fontes;
nullsignifica que não está definido./v1/cards-by-external-id/{external_id}lê e substitui o cartão por ele.length ≤ 512
metadataMetadata