Skip to content
Prefactor Docs

Create a new identity

POST
/api/v1/identity

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Identity_DetailsForCreate
object
factors
Array
One of:
FactorData_Email_ForInput

Data for an email factor

object
name
FactorName

A valid factor name from the pool’s ruleset

string
email
type
string
Allowed values: email 
email
value
EmailAddress

Email address

string format: email 
test@example.com
metadata
object
key
additional properties
string
pool_id
Pool_Id

A valid pool ID

string
013xrzp12g3nqk8n6z7f3q8wqgbmh3n9

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
Identity_Details

Details of an identity

object
account_id
Account_Id

A valid account ID

string
013xrzp12g3nqk8n505tp6wqnscpdy8q
claims
object
key
additional properties
string
domain_id
Domain_Id

A valid domain ID

string
013xrzp12g3nqk8nz2ccx5vt2j6f6hjz
factors
Array
One of:
FactorData_Email

Data for an email factor

object
identifier
boolean
name
FactorName

A valid factor name from the pool’s ruleset

string
email
nid
FactorNid

A valid factor NID

string
013xrzp12g3nqk8n2d067mwh5q1zn8j0
persistent
boolean
type
string
Allowed values: email 
email
value
EmailAddress

Email address

string format: email 
test@example.com
vid
Vid

A valid VID

string
013xrzp12g3nqk8n1b9rqhvn81pr1jy5
first_seen
One of:
InteractionDetails

A snapshot of the details of a particular device

object
asn
ASN

Autonomous System Number

integer
>= 1 
4764
at
Timestamp

Unix timestamp, seconds since midnight January 1, 1970 UTC

number
1234567890
city
City

City name

string
Melbourne
country_code
CountryCode

ISO 3166-1 alpha-2 country code

string
/^[A-Z]{2}$/ 
AU
ja4_fingerprint
JA4Fingerprint

JA4 TLS client fingerprint

string
q13d0314h3_55b375c5d22e_61e396c58b1f
lat_long
LatLong

Latitude and longitude coordinates as [latitude, longitude]

Array<number>
>= 2 items <= 2 items 
[
  -37.8159,
  144.9669
]
region_code
RegionCode

Region or state code

string
VIC
remote_ip
One of:

IPv4 address in dotted-decimal notation

string format: ipv4 
127.0.0.1
timezone
Timezone

IANA timezone identifier

string
Australia/Melbourne
user_agent
UserAgent

User-Agent string

string
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36
id
Identity_Id

A valid identity ID

string
013xrzp12g3nqk8nfsf13ajhjnj5hjp5
last_seen
One of:
InteractionDetails

A snapshot of the details of a particular device

object
asn
ASN

Autonomous System Number

integer
>= 1 
4764
at
Timestamp

Unix timestamp, seconds since midnight January 1, 1970 UTC

number
1234567890
city
City

City name

string
Melbourne
country_code
CountryCode

ISO 3166-1 alpha-2 country code

string
/^[A-Z]{2}$/ 
AU
ja4_fingerprint
JA4Fingerprint

JA4 TLS client fingerprint

string
q13d0314h3_55b375c5d22e_61e396c58b1f
lat_long
LatLong

Latitude and longitude coordinates as [latitude, longitude]

Array<number>
>= 2 items <= 2 items 
[
  -37.8159,
  144.9669
]
region_code
RegionCode

Region or state code

string
VIC
remote_ip
One of:

IPv4 address in dotted-decimal notation

string format: ipv4 
127.0.0.1
timezone
Timezone

IANA timezone identifier

string
Australia/Melbourne
user_agent
UserAgent

User-Agent string

string
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36
metadata
object
key
additional properties
string
pool_id
Pool_Id

A valid pool ID

string
013xrzp12g3nqk8n6z7f3q8wqgbmh3n9
status
string
Allowed values: extant deleted 
extant
title

Identity title (based on identifier)

string
hello@example.com
type

Type of resource (always ‘identity’)

string
Allowed values: identity 
identity
status
string
Allowed values: success 
success

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value 
bad_request
message
string
status
string
Allowed values: error 
error