For applying a projection, need to apply a query string parameter.

For details, refer to key query string parameters sections

​
1. Endpoint

POST/Projection
POST https://rest-api.argosidentity.com/v3/projection

​
2. Authentication

Include the API key in the x-api-key header:

x-api-key
x-api-key: {yourAPIKey}

​
3. Request Body

The request body must be in JSON format. Below are the field descriptions:

​
name
string
required

Set a projection name. Underscores (_), numbers, and lowercase characters are permitted.

​
mode
string
required

Set the projection mode. Currently, there is only the exclude option.

​
fields
array
required

Set the list to exclude specific fields.

  • first_nameThe first name that was submitted
  • last_nameThe last name that was submitted
  • full_nameThe full name that was submitted
  • gender: male or female
  • nationality: Country code, ISO alpha-3
  • date_of_birth: The submitted date of birth
  • ip_address: the address type of IPv4
  • idType: The type of ID (e.g., driver’s license, passport)
  • idcard_issuingCountry: Issuing country code, ISO alpha-3
  • idcard_issueDate: Issue Date of ID (YYYY-MM-DD)
  • idcard_expireDate: Expiry Date of ID (YYYY-MM-DD)
  • identityNumber
  • documentNumber
  • address_city
  • address_country
  • address_state
  • address_street
  • address_street2
  • address_zipcode
  • address_globalCode: Global address code (e.g., 8Q98HXPG+MP)
  • address_compoundCode: Compound address code (e.g., HXPG+MP, Seoul, South Korea)
  • address_formatted: Formatted detail address
  • address_input: Inputted address
  • address_detail: Inputted detail address
  • cf1: Custom field 1
  • cf2: Custom field 2
  • cf3: Custom field 3

Knowledge-Based supported fields

  • age_group
  • ssnNumber: Social Security Number.
    * For applying the lowerCamelCase convention to the written Number once more.
  • phoneNumber

e.g.

  • ["first_name","mid_name","last_name","full_name","idtype"]
  • ["date_of_birth","address_formatted","address_detail"]

​
4. Request Example

POST/Projection
curl --location 'https://rest-api.argosidentity.com/v3/projection' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}'
--data-raw '{
	"name": "{name}",
	"mode": "{mode}",
	"fields": ["{field1}","{field2}"]
}'

​
5. Response

​
5-1. Success Response

{
    "message": "Create projection success",
    "projection_id": "3zo1598m9mkrion"
}

​
5-2. Response Field

Field NameDescriptionData TypeCategory
projection_idThe unique ID of the generated projectionStringProjection Info

​
5-3. Error Codes

Status CodeError MessageDescription
400Invalid request body: name, mode, fieldsWhen required fields (name, mode, fields) are missing in the request body
400Invalid mode: $modeWhen the mode in the request body is invalid. (Currently only exclude is supported)
400Invalid fields detected: field1, field2When elements within the fields in the request body are invalid
400Invalid encrypted bodyWhen an improperly formatted encrypted request is sent while encryption option is enabled
400Invalid JSON bodyWhen the request body is not in valid JSON format
404Projection not foundWhen there is no projection corresponding to the specified projectionId
405Method not allowed for /projections pathHTTP requests (PUT, DELETE, etc.) are not GET or POST
409Projection name already existsThe same projection name has already been set
409Projection count limit exceededIf the number of projections exceeds the limit of 10 projections
500Internal server errorWhen the server encounters an unexpected exception error