Объект Document
содержит описание прикладываемого документа
Название | Тип | Формат | Обязательность | Описание |
---|---|---|---|---|
documentId | string | Guid | true |
Идентификатор документа. Заполняется клиентом. Должен быть уникален в рамках запроса, в котором участвует |
documentInfo | object | DocumentInfo | false |
Реквизиты документа |
content | object | Content | true |
Описание бинарных данных документа |
Чтобы описать бинарные данные документа, их предварительно необходимо загрузить методом POST /contents
Если в описании документа не будут указаны его реквизиты в
documentInfo
, то в качестве типа документа будет использован тип "Иные документы" (558502029900).
{
"documentId": "dd428e58-3220-4604-ba0b-7223413cdd1c",
"documentInfo":
{
"documentType": "558502029900",
"number": "2018/12/155",
"issueDate": "2018-12-04"
},
"content":
{
"contentInfo":
{
"contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
"contentType":"pdf",
"md5":"7E0D44C48AF788657EA6F5C4C87589E8"
},
"signatures":
[
{
"contentId": "c6780dbc-126b-44f6-9f7b-7422609d8ebb",
"contentType":"sig",
"md5":"F7415E33F972C03ABD4F3FED36748F7A"
},
{
"contentId": "8382ea4c-cd11-4be1-bfc6-a375b7e06c74",
"contentType":"sig",
"md5":"F7415E33F972C03ABD4F3FED36748F7A"
}
]
}
}
Объект DocumentInfo
содержит описание реквизитов документа
Название | Тип | Формат | Обязательность | Описание |
---|---|---|---|---|
documentType | string | DocumentType | true |
Тип документа |
number | string | ^[\w]{1,45}$ (*) |
false |
Номер документа |
series | string | ^[\w]{1,45}$ (*) |
false |
Серия документа |
issueDate | date | YYYY-MM-DD |
false |
Дата выдачи документа |
endingDate | date | YYYY-MM-DD |
false |
Дата окончания действия документа |
issuer | object | DocumentIssuer | false |
Издатель |
placeOfIssue | string | ^[\w]{1,1000}$ |
false |
Место выдачи. Обязательно только в закладной для Кредитного договора или денежного обязательства, исполнение которого обеспечивается ипотекой leagalAct |
Обязательность заполнения полей объекта DocumentInfo
зависит от типа документа, указанного в documentType
. Подробное описание обязательных реквизитов для всех типов документов указано в справочнике DocumentType.
(*)
Валидация полей number
и series
Если тип документа documentType указан как паспорт, то :
- поле номер
number
имеет валидацию^[\d]{6}$
- поле серия
series
имеет валидацию^[\d]{4}$
Если тип документа documentType указан как свидетельство о рождении, то :
- поле номер
number
имеет валидацию^[\d]{6}$
- поле серия
series
имеет валидацию^[A-Z]{1,4}[-]{1}[\А-Я]{2}
Объект DocumentIssuer
содержит описание организации, выдавшей документ, или автора документа.
Название | Тип | Формат | Обязательность | Описание |
---|---|---|---|---|
issuerCode | string | ^[\w]{1,20}$ |
false |
Код подразделения |
issuerName | string | ^[\w]{1,255}$ |
true |
Наименование организации |
Объект DocumentRef
содержит ссылку на документ Document
Название | Тип | Формат | Обязательность | Описание |
---|---|---|---|---|
documentId | string | Guid | true |
Идентификатор документа |