Persons

Create a person.

post/api/v2/persons

Request

Base URL: https://uk-api.leap.services
URL: https://uk-api.leap.services/api/v2/persons
Auth: one of:
- API key in header Authorization
- API key in header x-api-key

Headers

Authorizationstring required

LEAP Auth Token

Request body

birthDatestring date-time

Birth Date

birthPlacestring

Birth Place

countryOfBirthstring

Country Of Birth

deathPlacestring

Death Place

deathDatestring date-time

Death Date

passportNumberstring

Passport Number

passportNamestring

Passport Name

maidenNamestring

Maiden Name

specialNeedsstring

Special Needs

maritalStatusstring

MaritalStatus

irdNumberstring

(New Zealand) IRD Number - unique tax number given by the Inland Revenue Department

msdClientNumberstring

(New Zealand) Ministry of Social Development client number

custom1string

Custom 1

custom2string

Custom 2

custom3string

Custom 3

custom4string

Custom 4

custom5string

Custom 5

custom6string

Custom 6

custom7string

Custom 7

custom8string

Custom 8

custom9string

Custom 9

custom10string

Custom 10

custom11string

Custom 11

custom12string

Custom 12

commentsstring

Comments

gender'Male' | 'Female'

nationalitystring

Nationality

lastNamestring

Last Name

firstNamestring

First Name

occupationstring

Occupation

previousNamestring

Previous Name

languagestring

Language

salutationstring

Salutation

deletedboolean

Deleted

photoFileNamestring

Person photo file name.

Response

201 response

personIdstring uuid

skippedSensitiveFieldsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.