POST api/Nymcard/UploadUserIdentification?userId={userId}&identificationId={identificationId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

string

Required

identificationId

string

Required

Body Parameters

Collection of KYCFileInfo
NameDescriptionTypeAdditional information
FileContent

string

None.

IdentificationType

NymCardIdentificationTypes

None.

DocumentType

NymCardIdentificationDocumentTypes

None.

DocumentTypeName

string

None.

IdentificationTypeName

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "FileContent": "sample string 1",
    "IdentificationType": 0,
    "DocumentType": 0,
    "DocumentTypeName": "NATIONAL_ID_FRONT",
    "IdentificationTypeName": "PASSPORT"
  },
  {
    "FileContent": "sample string 1",
    "IdentificationType": 0,
    "DocumentType": 0,
    "DocumentTypeName": "NATIONAL_ID_FRONT",
    "IdentificationTypeName": "PASSPORT"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNYMCardApiServiceClient.KYCFileInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.NYMCARD">
  <NYMCardApiServiceClient.KYCFileInfo>
    <DocumentType>NATIONAL_ID_FRONT</DocumentType>
    <FileContent>sample string 1</FileContent>
    <IdentificationType>PASSPORT</IdentificationType>
  </NYMCardApiServiceClient.KYCFileInfo>
  <NYMCardApiServiceClient.KYCFileInfo>
    <DocumentType>NATIONAL_ID_FRONT</DocumentType>
    <FileContent>sample string 1</FileContent>
    <IdentificationType>PASSPORT</IdentificationType>
  </NYMCardApiServiceClient.KYCFileInfo>
</ArrayOfNYMCardApiServiceClient.KYCFileInfo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

UserIdentificationResponse
NameDescriptionTypeAdditional information
id

string

None.

type

string

None.

user_id

string

None.

number

string

None.

issuance_authority

string

None.

place_of_issuance

string

None.

expiration_date

string

None.

files

Collection of File

None.

identity_verification_user_data

IdentityVerificationUserData

None.

created

date

None.

modified

date

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "type": "sample string 2",
  "user_id": "sample string 3",
  "number": "sample string 4",
  "issuance_authority": "sample string 5",
  "place_of_issuance": "sample string 6",
  "expiration_date": "sample string 7",
  "files": [
    {
      "id": "sample string 1",
      "file_name": "sample string 2",
      "content_type": "sample string 3",
      "size": 4,
      "identification_type": "sample string 5",
      "identification_document_type": "sample string 6",
      "version": 7,
      "created": "2024-10-01T10:00:59.690255+00:00"
    },
    {
      "id": "sample string 1",
      "file_name": "sample string 2",
      "content_type": "sample string 3",
      "size": 4,
      "identification_type": "sample string 5",
      "identification_document_type": "sample string 6",
      "version": 7,
      "created": "2024-10-01T10:00:59.690255+00:00"
    }
  ],
  "identity_verification_user_data": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "date_of_birth": "sample string 3",
    "nationality": "sample string 4"
  },
  "created": "2024-10-01T10:00:59.690255+00:00",
  "modified": "2024-10-01T10:00:59.690255+00:00"
}

application/xml, text/xml

Sample:
<UserIdentificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.NYMCARD">
  <created>2024-10-01T10:00:59.690255+00:00</created>
  <expiration_date>sample string 7</expiration_date>
  <files>
    <File>
      <content_type>sample string 3</content_type>
      <created>2024-10-01T10:00:59.690255+00:00</created>
      <file_name>sample string 2</file_name>
      <id>sample string 1</id>
      <identification_document_type>sample string 6</identification_document_type>
      <identification_type>sample string 5</identification_type>
      <size>4</size>
      <version>7</version>
    </File>
    <File>
      <content_type>sample string 3</content_type>
      <created>2024-10-01T10:00:59.690255+00:00</created>
      <file_name>sample string 2</file_name>
      <id>sample string 1</id>
      <identification_document_type>sample string 6</identification_document_type>
      <identification_type>sample string 5</identification_type>
      <size>4</size>
      <version>7</version>
    </File>
  </files>
  <id>sample string 1</id>
  <identity_verification_user_data>
    <date_of_birth>sample string 3</date_of_birth>
    <first_name>sample string 1</first_name>
    <last_name>sample string 2</last_name>
    <nationality>sample string 4</nationality>
  </identity_verification_user_data>
  <issuance_authority>sample string 5</issuance_authority>
  <modified>2024-10-01T10:00:59.690255+00:00</modified>
  <number>sample string 4</number>
  <place_of_issuance>sample string 6</place_of_issuance>
  <type>sample string 2</type>
  <user_id>sample string 3</user_id>
</UserIdentificationResponse>