Skip to content
API Reference/
/
Create an identity docume...

Create an identity document

Request

Creates a new identity document.

Security
oauth2_client_credentials or oauth2_authorization_code
Query
documentIdstring, [ 4 .. 63 ] characters(document_id)

Optional. The ID to use for the document, which will become the final component of the document's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Example:documentId=passport-abc123
Bodyapplication/json

Required. The identity document to create.

One of:
namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document} string.resource_name = ["documents/*"] // value must be a valid resource name

typestring(type)required
Enum:"DOCUMENT_TYPE_UNSPECIFIED""DRIVERS_LICENCE""PASSPORT""AU_MEDICARE_CARD""VISA""BIRTH_CERTIFICATE"
entitystring(entity)

(OPTIONAL) Optional. The entity this document belongs to. Format: entities/{entity} string.resource_name = ["entities/*"] // value must be a valid resource name

auMedicareCardobject(au_medicare_card)required
curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/documents \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auMedicareCard": {
      "cardNumber": "string",
      "individualReferenceNumber": 1,
      "birthDate": {
        "year": 0,
        "month": 0,
        "day": 0
      },
      "cardExpiry": {
        "year": 0,
        "month": 0,
        "day": 0
      },
      "cardType": "CARD_TYPE_UNSPECIFIED",
      "fullName1": "string",
      "fullName2": "string",
      "fullName3": "string",
      "fullName4": "string",
      "expiryDate": {
        "year": 0,
        "month": 0,
        "day": 0
      }
    },
    "name": "string",
    "type": "DOCUMENT_TYPE_UNSPECIFIED",
    "entity": "string"
  }'

Responses

Success

Bodyapplication/json
One of:
namestring(name)

(IDENTIFIER) The resource name of the document. Format: documents/{document} string.resource_name = ["documents/*"] // value must be a valid resource name

typestring(type)required
Enum:"DOCUMENT_TYPE_UNSPECIFIED""DRIVERS_LICENCE""PASSPORT""AU_MEDICARE_CARD""VISA""BIRTH_CERTIFICATE"
entitystring(entity)

(OPTIONAL) Optional. The entity this document belongs to. Format: entities/{entity} string.resource_name = ["entities/*"] // value must be a valid resource name

createTimestring, (date-time)(create_time)read-only

Output only. The timestamp when the document was created.

Example:"2023-01-15T01:30:15.01Z"
updateTimestring, (date-time)(update_time)read-only

Output only. The timestamp when the document was most recently updated.

Example:"2023-01-15T01:30:15.01Z"
deleteTimestring, (date-time)(delete_time)read-only

Output only. The timestamp when the document was deleted. See AIP-164.

Example:"2023-01-15T01:30:15.01Z"
auMedicareCardobject(au_medicare_card)required
Response
{
  "name": "string",
  "type": "DOCUMENT_TYPE_UNSPECIFIED",
  "entity": "string",
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "deleteTime": "2023-01-15T01:30:15.01Z",
  "auMedicareCard": {
    "cardNumber": "string",
    "individualReferenceNumber": 1,
    "birthDate": { … },
    "cardExpiry": { … },
    "cardType": "CARD_TYPE_UNSPECIFIED",
    "fullName1": "string",
    "fullName2": "string",
    "fullName3": "string",
    "fullName4": "string",
    "expiryDate": { … }
  }
}