Onfido Addresses API
The Addresses API from Onfido — 1 operation(s) for addresses.
OpenAPI Specification
openapi: 3.0.0
info:
contact:
name: Onfido
url: https://public.support.onfido.com
description: "\nCreate trust at onboarding and beyond with a complete, AI-powered digital\nidentity solution built to help you know your customers online. \nAutomation allows you to acquire new customers and reduce costs while\nmeeting global KYC and AML compliance."
license:
name: MIT
title: Onfido Addresses API
version: v3.6
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
default: eu
enum:
- eu
- us
- ca
security:
- Token: []
tags:
- name: Addresses
paths:
/addresses/pick:
get:
description: 'Search for addresses by postcode
'
operationId: find_addresses
parameters:
- in: query
name: postcode
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Addresses_list'
description: A list of addresses
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Address Picker
tags:
- Addresses
components:
schemas:
ErrorProperties:
example:
type: type
message: message
fields:
key: ''
properties:
type:
type: string
message:
type: string
fields:
additionalProperties: true
type: object
title: ErrorProperties
type: object
address_shared:
properties:
flat_number:
description: The flat number of this address
type: string
building_number:
description: The building number of this address
type: string
building_name:
description: The building name of this address
type: string
street:
description: The street of the applicant's address
type: string
sub_street:
description: The sub-street of the applicant's address
type: string
town:
description: The town of the applicant's address
type: string
postcode:
description: The postcode or ZIP of the applicant's address
type: string
country:
allOf:
- $ref: '#/components/schemas/country_codes'
description: The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
type: string
state:
description: The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
type: string
line1:
description: Line 1 of the applicant's address
nullable: true
pattern: ^[^!$%^*=<>]*$
type: string
line2:
description: Line 2 of the applicant's address
nullable: true
pattern: ^[^!$%^*=<>]*$
type: string
line3:
description: Line 3 of the applicant's address
nullable: true
pattern: ^[^!$%^*=<>]*$
type: string
required:
- country
- postcode
type: object
country_codes:
enum:
- ABW
- AFG
- AGO
- AIA
- ALA
- ALB
- AND
- ARE
- ARG
- ARM
- ASM
- ATA
- ATF
- ATG
- AUS
- AUT
- AZE
- BDI
- BEL
- BEN
- BES
- BFA
- BGD
- BGR
- BHR
- BHS
- BIH
- BLM
- BLR
- BLZ
- BMU
- BOL
- BRA
- BRB
- BRN
- BTN
- BVT
- BWA
- CAF
- CAN
- CCK
- CHE
- CHL
- CHN
- CIV
- CMR
- COD
- COG
- COK
- COL
- COM
- CPV
- CRI
- CUB
- CUW
- CXR
- CYM
- CYP
- CZE
- DEU
- DJI
- DMA
- DNK
- DOM
- DZA
- ECU
- EGY
- ERI
- ESH
- ESP
- EST
- ETH
- FIN
- FJI
- FLK
- FRA
- FRO
- FSM
- GAB
- GBR
- GEO
- GGY
- GHA
- GIB
- GIN
- GLP
- GMB
- GNB
- GNQ
- GRC
- GRD
- GRL
- GTM
- GUF
- GUM
- GUY
- HKG
- HMD
- HND
- HRV
- HTI
- HUN
- IDN
- IMN
- IND
- IOT
- IRL
- IRN
- IRQ
- ISL
- ISR
- ITA
- JAM
- JEY
- JOR
- JPN
- KAZ
- KEN
- KGZ
- KHM
- KIR
- KNA
- KOR
- KWT
- LAO
- LBN
- LBR
- LBY
- LCA
- LIE
- LKA
- LSO
- LTU
- LUX
- LVA
- MAC
- MAF
- MAR
- MCO
- MDA
- MDG
- MDV
- MEX
- MHL
- MKD
- MLI
- MLT
- MMR
- MNE
- MNG
- MNP
- MOZ
- MRT
- MSR
- MTQ
- MUS
- MWI
- MYS
- MYT
- NAM
- NCL
- NER
- NFK
- NGA
- NIC
- NIU
- NLD
- NOR
- NPL
- NRU
- NZL
- OMN
- PAK
- PAN
- PCN
- PER
- PHL
- PLW
- PNG
- POL
- PRI
- PRK
- PRT
- PRY
- PSE
- PYF
- QAT
- REU
- RKS
- ROU
- RUS
- RWA
- SAU
- SDN
- SEN
- SGP
- SGS
- SHN
- SJM
- SLB
- SLE
- SLV
- SMR
- SOM
- SPM
- SRB
- SSD
- STP
- SUR
- SVK
- SVN
- SWE
- SWZ
- SXM
- SYC
- SYR
- TCA
- TCD
- TGO
- THA
- TJK
- TKL
- TKM
- TLS
- TON
- TTO
- TUN
- TUR
- TUV
- TWN
- TZA
- UGA
- UKR
- UMI
- URY
- USA
- UZB
- VAT
- VCT
- VEN
- VGB
- VIR
- VNM
- VUT
- WLF
- WSM
- YEM
- ZAF
- ZMB
- ZWE
type: string
address:
allOf:
- $ref: '#/components/schemas/address_shared'
example:
building_name: building_name
country: country
town: town
flat_number: flat_number
street: street
postcode: postcode
state: state
line3: line3
line2: line2
building_number: building_number
line1: line1
sub_street: sub_street
Error:
example:
error:
type: type
message: message
fields:
key: ''
properties:
error:
$ref: '#/components/schemas/ErrorProperties'
title: Error
type: object
Addresses_list:
example:
addresses:
- building_name: building_name
country: country
town: town
flat_number: flat_number
street: street
postcode: postcode
state: state
line3: line3
line2: line2
building_number: building_number
line1: line1
sub_street: sub_street
- building_name: building_name
country: country
town: town
flat_number: flat_number
street: street
postcode: postcode
state: state
line3: line3
line2: line2
building_number: building_number
line1: line1
sub_street: sub_street
properties:
addresses:
items:
$ref: '#/components/schemas/address'
type: array
required:
- address
title: Addresses list
type: object
securitySchemes:
Token:
in: header
name: Authorization
type: apiKey
externalDocs:
url: https://documentation.onfido.com