POST api/Nymcard/SearchIdentification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
query	string	None.
sort_by	string	None.
order_by	string	None.
matcher	Collection of string	None.
filters	Collection of Filter	None.
cursors	Cursors	None.
limit	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "query": "sample string 1",
  "sort_by": "sample string 2",
  "order_by": "sample string 3",
  "matcher": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "field": "sample string 1",
      "operator": "sample string 2",
      "values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "field": "sample string 1",
      "operator": "sample string 2",
      "values": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "cursors": {
    "after": "sample string 1",
    "has_more": true
  },
  "limit": 4
}

application/xml, text/xml

Sample:

<SearchUserForIdentificationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.NYMCARD">
  <cursors>
    <after>sample string 1</after>
    <has_more>true</has_more>
  </cursors>
  <filters>
    <Filter>
      <field>sample string 1</field>
      <operator>sample string 2</operator>
      <values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </values>
    </Filter>
    <Filter>
      <field>sample string 1</field>
      <operator>sample string 2</operator>
      <values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </values>
    </Filter>
  </filters>
  <limit>4</limit>
  <matcher xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </matcher>
  <order_by>sample string 3</order_by>
  <query>sample string 1</query>
  <sort_by>sample string 2</sort_by>
</SearchUserForIdentificationInput>

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 'SearchUserForIdentificationInput'.

Response Information

Resource Description

SearchedUserInfo

Name	Type	Additional information
after	string	None.
has_more	boolean	None.
data	Collection of SearchUser	None.

Response Formats

application/json, text/json

Sample:

{
  "after": "sample string 1",
  "has_more": true,
  "data": [
    {
      "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",
      "issuance_date": "2023-03-31T00:12:17.8536799+00:00",
      "expiration_date": "2023-03-31T00:12:17.8536799+00:00",
      "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": "2023-03-31T00:12:17.8536799+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": "2023-03-31T00:12:17.8536799+00:00"
        }
      ],
      "created": "2023-03-31T00:12:17.8536799+00:00",
      "modified": "2023-03-31T00:12:17.8536799+00:00"
    },
    {
      "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",
      "issuance_date": "2023-03-31T00:12:17.8536799+00:00",
      "expiration_date": "2023-03-31T00:12:17.8536799+00:00",
      "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": "2023-03-31T00:12:17.8536799+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": "2023-03-31T00:12:17.8536799+00:00"
        }
      ],
      "created": "2023-03-31T00:12:17.8536799+00:00",
      "modified": "2023-03-31T00:12:17.8536799+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchedUserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.Integrations.NYMCARD">
  <after>sample string 1</after>
  <data>
    <SearchUser>
      <created>2023-03-31T00:12:17.8536799+00:00</created>
      <expiration_date>2023-03-31T00:12:17.8536799+00:00</expiration_date>
      <files>
        <File>
          <content_type>sample string 3</content_type>
          <created>2023-03-31T00:12:17.8536799+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>2023-03-31T00:12:17.8536799+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>
      <issuance_authority>sample string 5</issuance_authority>
      <issuance_date>2023-03-31T00:12:17.8536799+00:00</issuance_date>
      <modified>2023-03-31T00:12:17.8536799+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>
    </SearchUser>
    <SearchUser>
      <created>2023-03-31T00:12:17.8536799+00:00</created>
      <expiration_date>2023-03-31T00:12:17.8536799+00:00</expiration_date>
      <files>
        <File>
          <content_type>sample string 3</content_type>
          <created>2023-03-31T00:12:17.8536799+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>2023-03-31T00:12:17.8536799+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>
      <issuance_authority>sample string 5</issuance_authority>
      <issuance_date>2023-03-31T00:12:17.8536799+00:00</issuance_date>
      <modified>2023-03-31T00:12:17.8536799+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>
    </SearchUser>
  </data>
  <has_more>true</has_more>
</SearchedUserInfo>