openapi: 3.0.0 info: title: GBG GO Next Gen Flow Captain API version: 1.0.0 description: API for Customers and End Users to interact with the GBG GO Next Gen Flow Captain contact: name: GBG GO Next Generation Flow Captain API Team url: https://gbgplc.com email: tbd@gbg.com servers: - url: https://eu.platform.go.gbgplc.com/v2/captain - url: https://us.platform.go.gbgplc.com/v2/captain - url: https://au.platform.go.gbgplc.com/v2/captain paths: "/as/token.oauth2": post: summary: Generate access token description: Get an access token to authenticate API requests. If you're unfamiliar with the authentication process, check out the [authentication guide](/docs/go-v2/developer-integration/execute-customer-journeys/authenticate) for more details. security: [] servers: - url: https://api.auth.gbgplc.com requestBody: content: application/x-www-form-urlencoded: schema: oneOf: - $ref: "#/components/schemas/PasswordGrantRequest" - $ref: "#/components/schemas/ClientCredentialsGrantRequest" discriminator: propertyName: grant_type mapping: password: "#/components/schemas/PasswordGrantRequest" client_credentials: "#/components/schemas/ClientCredentialsGrantRequest" responses: "200": description: Successfully retrieved access token. content: application/json: schema: type: object properties: access_token: type: string description: The access token used for authentication. expires_in: type: integer description: Token expiration time in seconds. token_type: type: string description: The type of token, usually 'Bearer'. "400": description: Invalid request. Check your credentials. "401": description: Unauthorized request. Invalid username or password. tags: - Journey execution x-speakeasy-group: tokens x-speakeasy-name-override: generate # /auth/realms/go/protocol/openid-connect/token: # post: # summary: Generate access token # description: >- # Get an access token to authenticate API requests. If you're unfamiliar # with the authentication process, check out the [authentication # guide](/docs/developer-integration/execute-customer-journeys/authenticate) # for more details. # security: [] # servers: # - url: https://eu.platform.go.gbgplc.com # - url: https://us.platform.go.gbgplc.com # - url: https://au.platform.go.gbgplc.com # requestBody: # content: # application/x-www-form-urlencoded: # schema: # type: object # properties: # client_id: # type: string # description: The client ID assigned to your organization. # example: your_client_id # client_secret: # type: string # description: The client secret assigned to your organization. # example: your_client_secret # username: # type: string # description: The username for API authentication. # example: your_username # password: # type: string # description: The password for API authentication. # example: your_password # grant_type: # type: string # enum: # - password # description: Must always be set to 'password'. # example: password # required: # - client_id # - client_secret # - username # - password # - grant_type # example: # client_id: your-client-id # client_secret: your-client-secret # username: api-user@example.com # password: your-secure-password # grant_type: password # responses: # "200": # description: Successfully retrieved access token. # content: # application/json: # schema: # type: object # properties: # access_token: # type: string # description: The access token used for authentication. # example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... # expires_in: # type: integer # description: Token expiration time in seconds. # example: 3600 # token_type: # type: string # description: The type of token, usually 'Bearer'. # example: Bearer # "400": # description: Invalid request. Check your credentials. # "401": # description: Unauthorized request. Invalid username or password. # x-speakeasy-group: tokens # x-speakeasy-name-override: generate /journey/health: get: operationId: health summary: Obtain the flow-captain health status description: Obtain the flow-captain health status tags: - Health parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: message: type: string required: - message additionalProperties: true example: message: OK "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/device/connect: post: operationId: deviceConnect summary: Connect or Refresh End User Device description: Connect or Refresh End User Device tags: - End User APIs - One Time Token Service security: - DeviceConnect: [] requestBody: content: application/json: schema: type: object properties: connectToken: type: string minLength: 8 maxLength: 1024 pattern: ^[A-Za-z0-9-_]+$ description: Bearer Token credential for a connection. deviceInfo: type: object properties: deviceId: type: string minLength: 16 maxLength: 64 description: Device Id, a unique identifier for a device. deviceName: type: string deviceType: type: string required: - deviceId additionalProperties: false required: - connectToken - deviceInfo additionalProperties: false example: deviceInfo: deviceId: exampleDeviceId123 deviceName: deviceName deviceType: deviceType connectToken: s4FUx8Ny8ijXRtFigz3x1_8rb9bd_5ZD parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: endUserToken: type: string minLength: 8 maxLength: 1024 pattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$ description: Token used for subsequent operations by the client tokenType: type: string enum: - Bearer - DPoP - N_A - end-user default: Bearer expiresIn: type: number exclusiveMinimum: true minimum: 0 description: Seconds until the token expires required: - expiresIn additionalProperties: false examples: Default: value: endUserToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJqdGkiOiJsRzlsZnZTVFVrcGNTTkVmSWx3amZXT1JRMkJwZEhGcCIsInNjb3BlIjpbImRlbW8zNCIsImF1dGgiXSwiaWF0IjoxNzEyMDc1OTMwLCJleHAiOjE3MTIwNzk1MzAsImF1ZCI6InVzLWVhc3QtMS5nYmdnby5jb20vI2RldmljZSJ9.Adn32WkNlhAlyFyHLH9EEVvFHk-FIhQn9Wiphb_BTRI tokenType: end-user expiresIn: 3600 "201": description: Success content: application/json: schema: type: object properties: endUserToken: type: string minLength: 8 maxLength: 1024 pattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$ description: Token used for subsequent operations by the client tokenType: type: string enum: - Bearer - DPoP - N_A - end-user default: Bearer expiresIn: type: number exclusiveMinimum: true minimum: 0 description: Seconds until the token expires required: - expiresIn additionalProperties: false examples: Default: value: endUserToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJqdGkiOiJsRzlsZnZTVFVrcGNTTkVmSWx3amZXT1JRMkJwZEhGcCIsInNjb3BlIjpbImRlbW8zNCIsImF1dGgiXSwiaWF0IjoxNzEyMDc1OTMwLCJleHAiOjE3MTIwNzk1MzAsImF1ZCI6InVzLWVhc3QtMS5nYmdnby5jb20vI2RldmljZSJ9.Adn32WkNlhAlyFyHLH9EEVvFHk-FIhQn9Wiphb_BTRI tokenType: end-user expiresIn: 3600 "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/task/list: post: operationId: getTasks summary: Get End User Tasks description: Get End User Tasks tags: - End User APIs - Task Service security: - PingID: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: true example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. status: type: string enum: - Completed - InProgress - Failed - Paused tasks: type: array items: type: object properties: taskId: type: string minLength: 16 maxLength: 64 description: Task Id, a unique identifier for a task assigned to an End User during a Journey. required: - taskId additionalProperties: false required: - instanceId - status - tasks additionalProperties: false examples: Default: value: status: InProgress instanceId: PiIuACmx8Q8R7qPnAkLAqBAT tasks: - taskId: TkoviRO58Q8R7qPnAkLAqBAT "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/task/update: post: operationId: updateTask summary: Put End User Data description: Put End User Data tags: - End User APIs - Task Service security: - PingID: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. taskId: type: string minLength: 16 maxLength: 64 description: Task Id, a unique identifier for a task assigned to an End User during a Journey. intent: type: string enum: - Save - Complete - Validate context: type: object properties: subject: type: object properties: identity: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false documents: type: array items: type: object properties: oneDBarcode: type: string address: type: object properties: addressString: type: string extractedAddressString: type: string addressLine1: type: string addressLine2: type: string locality: type: string administrativeArea: type: string postalCode: type: string additionalProperties: false applicationDate: type: string applicationNumber: type: string dateOfBirth: type: string placeOfBirth: type: string placeOfBirthNative: type: string bloodType: type: string controlNumber: type: string countryCode: type: string countryName: type: string documentClassCode: type: string documentClassName: type: string documentNumber: type: string documentSignerCertificate: type: string employer: type: string employerAddress: type: string entries: type: string expirationDate: type: string eyeColor: type: string fathersName: type: string fathersNameNative: type: string fathersSurname: type: string firstName: type: string fullName: type: string fullNameNative: type: string givenName: type: string givenNameNative: type: string hairColor: type: string height: type: string issueDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 issuingAuthority: type: string issuingAuthorityNative: type: string issuingStateCode: type: string issuingStateName: type: string licenseClass: type: string licenseEndorsements: type: string licenseRestrictions: type: string mrz: type: string mrz1: type: string mrz2: type: string mrz3: type: string middleName: type: string mothersName: type: string mothersNameNative: type: string mothersSurname: type: string nameSuffix: type: string nationalityCode: type: string nationalityName: type: string nationalityNameNative: type: string occupation: type: string organDonor: type: boolean passportNumber: type: string permitNumber: type: string personalNumber: type: string photo: type: string photoCompressed: type: string photoEncoding: type: string sex: type: string sexNative: type: string signature: type: string signatureCompressed: type: string signatureEncoding: type: string socialSecurityNumber: type: string startDate: type: string surname: type: string surnameNative: type: string visaClass: type: string visaNumber: type: string weight: type: string cardNumber: type: string issuerCountryCode: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code id: type: string type: type: string category: type: string subtype: type: string format: type: string device: type: object properties: type: type: string model: type: string hasContactlessReader: type: boolean hasMagneticStripeReader: type: boolean hasCamera: type: boolean serialNumber: type: string manufacturer: type: string additionalProperties: false side1Image: type: string side2Image: type: string chip: type: object properties: lds: type: array items: type: object properties: name: type: string enum: - COM - SOD - DG1 - DG2 - DG3 - DG4 - DG5 - DG6 - DG7 - DG8 - DG9 - DG10 - DG11 - DG12 - DG13 - DG14 - DG15 data: type: string required: - name - data additionalProperties: true auth: type: array items: type: object properties: type: type: string enum: - ActiveAuthentication - BasicAccessControl - ChipAuthentication - PassiveAuthentication - SupplementalAccessControl - ExtendedAccessControl - TerminalAuthentication result: type: string enum: - Success - Failure - Skipped required: - type - result additionalProperties: true required: - lds - auth additionalProperties: true classification: type: object properties: ids: type: array items: type: string category: type: string type: type: string subtype: type: string isDoubleSided: type: boolean hasNFC: type: boolean year: type: string countryCode: type: string countryName: type: string stateCode: type: string stateName: type: string sides: type: array items: type: object properties: side: type: string id: type: string documentQuality: type: string documentQualityScore: type: number required: - side - id - documentQuality - documentQualityScore additionalProperties: false additionalProperties: false extraction: type: object properties: aggregatedFields: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false extractedFields: type: array items: type: object properties: label: type: string details: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false required: - label - details additionalProperties: false extractedImages: type: array items: type: object properties: label: type: string side: type: string imageID: type: string required: - label - side - imageID additionalProperties: false additionalProperties: false validation: type: object properties: validationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false aggregatedValidationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false additionalProperties: false subType: type: string number: type: string expiryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 subject: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code additionalProperties: false biometrics: type: array items: anyOf: - type: object properties: id: type: string type: type: string face1Image: type: string face2Image: type: string required: - face1Image - face2Image additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string anchorImage: type: string required: - selfieImage - anchorImage additionalProperties: false - type: object properties: id: type: string type: type: string faceImage: type: string required: - faceImage additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string selfieImageEncryption: type: boolean required: - selfieImage additionalProperties: false sessions: type: array items: type: object properties: user: type: object properties: id: type: string email: type: string format: email domain: type: string required: - id - email - domain additionalProperties: false client: type: object properties: id: type: string ip: type: string address: type: string required: - id - ip - address additionalProperties: false device: type: object properties: id: type: string manufacturer: type: string model: type: object properties: identifier: type: string name: type: string required: - identifier - name additionalProperties: false required: - id - manufacturer - model additionalProperties: false trace: type: object properties: id: type: string required: - id additionalProperties: false span: type: object properties: id: type: string required: - id additionalProperties: false transaction: type: object properties: id: type: string required: - id additionalProperties: false auth: type: array items: type: object properties: id: type: string scope: type: string codeVerifier: type: string code: type: string state: type: string redirectUri: type: string responseType: type: string clientId: type: string clientSecret: type: string required: - id additionalProperties: false additionalProperties: false consent: type: array items: allOf: - type: object properties: type: type: string enum: - rollup - explicit - implicit id: type: string version: type: string url: type: string format: uri effectiveDate: type: string expiryDate: type: string terms: type: string purpose: type: string legalBasis: type: string jurisdiction: type: string subject: type: string signatory: type: string additionalProperties: false - type: object properties: url: type: string format: uri required: - url additionalProperties: false accounts: type: array items: type: object properties: type: type: string description: The type of account, e.g. Bank Account, Building Society accountNumber: type: string description: Account number sortCode: type: string description: UK sort code routingNumber: type: string description: US ABA routing number iban: type: string description: International Bank Account Number bic: type: string description: BIC/SWIFT code accountHolderName: type: string description: Name on the account bankName: type: string description: Name of the financial institution country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code accountType: type: string description: Account classification, e.g. current, savings required: - type - accountNumber additionalProperties: false uid: type: string additionalProperties: false required: - subject additionalProperties: false data: type: object properties: {} additionalProperties: true required: - instanceId - taskId - intent additionalProperties: false example: intent: Complete instanceId: PiIuACmx8Q8R7qPnAkLAqBAT taskId: TkoviRO58Q8R7qPnAkLAqBAT context: subject: identity: firstName: test parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. taskId: type: string minLength: 16 maxLength: 64 description: Task Id, a unique identifier for a task assigned to an End User during a Journey. required: - instanceId - taskId additionalProperties: false examples: Default: value: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT taskId: TkoviRO58Q8R7qPnAkLAqBAT "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/start: post: operationId: startJourney summary: Start Journey description: Start Journey tags: - Customer APIs - Flow Dispatch Service security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: resourceId: type: string minLength: 16 maxLength: 64 description: Resource Id, a unique identifier for a resource, such as a journey or instance. context: type: object properties: config: type: object properties: delivery: type: string description: The method by which the End User will consume the journey. enum: - page - api required: - delivery subject: type: object properties: identity: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false documents: type: array items: type: object properties: oneDBarcode: type: string address: type: object properties: addressString: type: string extractedAddressString: type: string addressLine1: type: string addressLine2: type: string locality: type: string administrativeArea: type: string postalCode: type: string additionalProperties: false applicationDate: type: string applicationNumber: type: string dateOfBirth: type: string placeOfBirth: type: string placeOfBirthNative: type: string bloodType: type: string controlNumber: type: string countryCode: type: string countryName: type: string documentClassCode: type: string documentClassName: type: string documentNumber: type: string documentSignerCertificate: type: string employer: type: string employerAddress: type: string entries: type: string expirationDate: type: string eyeColor: type: string fathersName: type: string fathersNameNative: type: string fathersSurname: type: string firstName: type: string fullName: type: string fullNameNative: type: string givenName: type: string givenNameNative: type: string hairColor: type: string height: type: string issueDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 issuingAuthority: type: string issuingAuthorityNative: type: string issuingStateCode: type: string issuingStateName: type: string licenseClass: type: string licenseEndorsements: type: string licenseRestrictions: type: string mrz: type: string mrz1: type: string mrz2: type: string mrz3: type: string middleName: type: string mothersName: type: string mothersNameNative: type: string mothersSurname: type: string nameSuffix: type: string nationalityCode: type: string nationalityName: type: string nationalityNameNative: type: string occupation: type: string organDonor: type: boolean passportNumber: type: string permitNumber: type: string personalNumber: type: string photo: type: string photoCompressed: type: string photoEncoding: type: string sex: type: string sexNative: type: string signature: type: string signatureCompressed: type: string signatureEncoding: type: string socialSecurityNumber: type: string startDate: type: string surname: type: string surnameNative: type: string visaClass: type: string visaNumber: type: string weight: type: string cardNumber: type: string issuerCountryCode: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code id: type: string type: type: string category: type: string subtype: type: string format: type: string device: type: object properties: type: type: string model: type: string hasContactlessReader: type: boolean hasMagneticStripeReader: type: boolean hasCamera: type: boolean serialNumber: type: string manufacturer: type: string additionalProperties: false side1Image: type: string side2Image: type: string chip: type: object properties: lds: type: array items: type: object properties: name: type: string enum: - COM - SOD - DG1 - DG2 - DG3 - DG4 - DG5 - DG6 - DG7 - DG8 - DG9 - DG10 - DG11 - DG12 - DG13 - DG14 - DG15 data: type: string required: - name - data additionalProperties: true auth: type: array items: type: object properties: type: type: string enum: - ActiveAuthentication - BasicAccessControl - ChipAuthentication - PassiveAuthentication - SupplementalAccessControl - ExtendedAccessControl - TerminalAuthentication result: type: string enum: - Success - Failure - Skipped required: - type - result additionalProperties: true required: - lds - auth additionalProperties: true classification: type: object properties: ids: type: array items: type: string category: type: string type: type: string subtype: type: string isDoubleSided: type: boolean hasNFC: type: boolean year: type: string countryCode: type: string countryName: type: string stateCode: type: string stateName: type: string sides: type: array items: type: object properties: side: type: string id: type: string documentQuality: type: string documentQualityScore: type: number required: - side - id - documentQuality - documentQualityScore additionalProperties: false additionalProperties: false extraction: type: object properties: aggregatedFields: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false extractedFields: type: array items: type: object properties: label: type: string details: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false required: - label - details additionalProperties: false extractedImages: type: array items: type: object properties: label: type: string side: type: string imageID: type: string required: - label - side - imageID additionalProperties: false additionalProperties: false validation: type: object properties: validationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false aggregatedValidationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false additionalProperties: false subType: type: string number: type: string expiryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 subject: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code additionalProperties: false biometrics: type: array items: anyOf: - type: object properties: id: type: string type: type: string face1Image: type: string face2Image: type: string required: - face1Image - face2Image additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string anchorImage: type: string required: - selfieImage - anchorImage additionalProperties: false - type: object properties: id: type: string type: type: string faceImage: type: string required: - faceImage additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string selfieImageEncryption: type: boolean required: - selfieImage additionalProperties: false sessions: type: array items: type: object properties: user: type: object properties: id: type: string email: type: string format: email domain: type: string required: - id - email - domain additionalProperties: false client: type: object properties: id: type: string ip: type: string address: type: string required: - id - ip - address additionalProperties: false device: type: object properties: id: type: string manufacturer: type: string model: type: object properties: identifier: type: string name: type: string required: - identifier - name additionalProperties: false required: - id - manufacturer - model additionalProperties: false trace: type: object properties: id: type: string required: - id additionalProperties: false span: type: object properties: id: type: string required: - id additionalProperties: false transaction: type: object properties: id: type: string required: - id additionalProperties: false auth: type: array items: type: object properties: id: type: string scope: type: string codeVerifier: type: string code: type: string state: type: string redirectUri: type: string responseType: type: string clientId: type: string clientSecret: type: string required: - id additionalProperties: false additionalProperties: false consent: type: array items: allOf: - type: object properties: type: type: string enum: - rollup - explicit - implicit id: type: string version: type: string url: type: string format: uri effectiveDate: type: string expiryDate: type: string terms: type: string purpose: type: string legalBasis: type: string jurisdiction: type: string subject: type: string signatory: type: string additionalProperties: false - type: object properties: url: type: string format: uri required: - url additionalProperties: false accounts: type: array items: type: object properties: type: type: string description: The type of account, e.g. Bank Account, Building Society accountNumber: type: string description: Account number sortCode: type: string description: UK sort code routingNumber: type: string description: US ABA routing number iban: type: string description: International Bank Account Number bic: type: string description: BIC/SWIFT code accountHolderName: type: string description: Name on the account bankName: type: string description: Name of the financial institution country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code accountType: type: string description: Account classification, e.g. current, savings required: - type - accountNumber additionalProperties: false uid: type: string additionalProperties: false required: - subject - config additionalProperties: false data: type: object properties: {} additionalProperties: true required: - resourceId additionalProperties: false example: resourceId: a4c68509c24789888eb466@latest context: subject: identity: {} parameters: [] responses: "200": description: Start Response contains the Journey Instance Id content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: true description: Start Response contains the Journey Instance Id examples: Default: value: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT "201": description: Start Response contains the Journey Instance Id content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: true description: Start Response contains the Journey Instance Id examples: Default: value: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/device/start: post: operationId: addDevice summary: Create Connect Secret description: Create Connect Secret tags: - Customer APIs - One Time Token Service security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. scope: type: array items: type: string enum: - mobile - desktop - "*" - any - "" required: - instanceId - scope additionalProperties: false example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT scope: - mobile parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: connectToken: type: string minLength: 8 maxLength: 1024 pattern: ^[A-Za-z0-9-_]+$ description: Token used for subsequent operations by the client tokenType: type: string enum: - Bearer - DPoP - N_A - connect default: Bearer expiresIn: type: number exclusiveMinimum: true minimum: 0 description: Seconds until the token expires scope: type: array items: type: string enum: - mobile - desktop - "*" - any - "" description: Scopes granted to the client required: - connectToken - expiresIn additionalProperties: false examples: Default: value: connectToken: s4FUx8Ny8ijXRtFigz3x1_8rb9bd_5ZD tokenType: connect expiresIn: 120 scope: - any "201": description: Success content: application/json: schema: type: object properties: connectToken: type: string minLength: 8 maxLength: 1024 pattern: ^[A-Za-z0-9-_]+$ description: Token used for subsequent operations by the client tokenType: type: string enum: - Bearer - DPoP - N_A - connect default: Bearer expiresIn: type: number exclusiveMinimum: true minimum: 0 description: Seconds until the token expires scope: type: array items: type: string enum: - mobile - desktop - "*" - any - "" description: Scopes granted to the client required: - connectToken - expiresIn additionalProperties: false examples: Default: value: connectToken: s4FUx8Ny8ijXRtFigz3x1_8rb9bd_5ZD tokenType: connect expiresIn: 120 scope: - any "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/state/fetch: post: operationId: getJourneyState summary: Get State Data description: Get State Data tags: - Customer APIs - Flow Dispatch Service security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. filterKeys: type: array items: type: string required: - instanceId additionalProperties: false example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT filterKeys: - /.*/ parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. status: type: string enum: - Completed - InProgress - Failed - Paused metaData: type: object properties: createdTime: type: string completedTime: type: string additionalProperties: true context: type: object properties: subject: type: object properties: identity: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false documents: type: array items: type: object properties: oneDBarcode: type: string address: type: object properties: addressString: type: string extractedAddressString: type: string addressLine1: type: string addressLine2: type: string locality: type: string administrativeArea: type: string postalCode: type: string additionalProperties: false applicationDate: type: string applicationNumber: type: string dateOfBirth: type: string placeOfBirth: type: string placeOfBirthNative: type: string bloodType: type: string controlNumber: type: string countryCode: type: string countryName: type: string documentClassCode: type: string documentClassName: type: string documentNumber: type: string documentSignerCertificate: type: string employer: type: string employerAddress: type: string entries: type: string expirationDate: type: string eyeColor: type: string fathersName: type: string fathersNameNative: type: string fathersSurname: type: string firstName: type: string fullName: type: string fullNameNative: type: string givenName: type: string givenNameNative: type: string hairColor: type: string height: type: string issueDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 issuingAuthority: type: string issuingAuthorityNative: type: string issuingStateCode: type: string issuingStateName: type: string licenseClass: type: string licenseEndorsements: type: string licenseRestrictions: type: string mrz: type: string mrz1: type: string mrz2: type: string mrz3: type: string middleName: type: string mothersName: type: string mothersNameNative: type: string mothersSurname: type: string nameSuffix: type: string nationalityCode: type: string nationalityName: type: string nationalityNameNative: type: string occupation: type: string organDonor: type: boolean passportNumber: type: string permitNumber: type: string personalNumber: type: string photo: type: string photoCompressed: type: string photoEncoding: type: string sex: type: string sexNative: type: string signature: type: string signatureCompressed: type: string signatureEncoding: type: string socialSecurityNumber: type: string startDate: type: string surname: type: string surnameNative: type: string visaClass: type: string visaNumber: type: string weight: type: string cardNumber: type: string issuerCountryCode: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code id: type: string type: type: string category: type: string subtype: type: string format: type: string device: type: object properties: type: type: string model: type: string hasContactlessReader: type: boolean hasMagneticStripeReader: type: boolean hasCamera: type: boolean serialNumber: type: string manufacturer: type: string additionalProperties: false side1Image: type: string side2Image: type: string chip: type: object properties: lds: type: array items: type: object properties: name: type: string enum: - COM - SOD - DG1 - DG2 - DG3 - DG4 - DG5 - DG6 - DG7 - DG8 - DG9 - DG10 - DG11 - DG12 - DG13 - DG14 - DG15 data: type: string required: - name - data additionalProperties: true auth: type: array items: type: object properties: type: type: string enum: - ActiveAuthentication - BasicAccessControl - ChipAuthentication - PassiveAuthentication - SupplementalAccessControl - ExtendedAccessControl - TerminalAuthentication result: type: string enum: - Success - Failure - Skipped required: - type - result additionalProperties: true required: - lds - auth additionalProperties: true classification: type: object properties: ids: type: array items: type: string category: type: string type: type: string subtype: type: string isDoubleSided: type: boolean hasNFC: type: boolean year: type: string countryCode: type: string countryName: type: string stateCode: type: string stateName: type: string sides: type: array items: type: object properties: side: type: string id: type: string documentQuality: type: string documentQualityScore: type: number required: - side - id - documentQuality - documentQualityScore additionalProperties: false additionalProperties: false extraction: type: object properties: aggregatedFields: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false extractedFields: type: array items: type: object properties: label: type: string details: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false required: - label - details additionalProperties: false extractedImages: type: array items: type: object properties: label: type: string side: type: string imageID: type: string required: - label - side - imageID additionalProperties: false additionalProperties: false validation: type: object properties: validationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false aggregatedValidationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false additionalProperties: false subType: type: string number: type: string expiryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 subject: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code additionalProperties: false biometrics: type: array items: anyOf: - type: object properties: id: type: string type: type: string face1Image: type: string face2Image: type: string required: - face1Image - face2Image additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string anchorImage: type: string required: - selfieImage - anchorImage additionalProperties: false - type: object properties: id: type: string type: type: string faceImage: type: string required: - faceImage additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string selfieImageEncryption: type: boolean required: - selfieImage additionalProperties: false sessions: type: array items: type: object properties: user: type: object properties: id: type: string email: type: string format: email domain: type: string required: - id - email - domain additionalProperties: false client: type: object properties: id: type: string ip: type: string address: type: string required: - id - ip - address additionalProperties: false device: type: object properties: id: type: string manufacturer: type: string model: type: object properties: identifier: type: string name: type: string required: - identifier - name additionalProperties: false required: - id - manufacturer - model additionalProperties: false trace: type: object properties: id: type: string required: - id additionalProperties: false span: type: object properties: id: type: string required: - id additionalProperties: false transaction: type: object properties: id: type: string required: - id additionalProperties: false auth: type: array items: type: object properties: id: type: string scope: type: string codeVerifier: type: string code: type: string state: type: string redirectUri: type: string responseType: type: string clientId: type: string clientSecret: type: string required: - id additionalProperties: false additionalProperties: false consent: type: array items: allOf: - type: object properties: type: type: string enum: - rollup - explicit - implicit id: type: string version: type: string url: type: string format: uri effectiveDate: type: string expiryDate: type: string terms: type: string purpose: type: string legalBasis: type: string jurisdiction: type: string subject: type: string signatory: type: string additionalProperties: false - type: object properties: url: type: string format: uri required: - url additionalProperties: false accounts: type: array items: type: object properties: type: type: string description: The type of account, e.g. Bank Account, Building Society accountNumber: type: string description: Account number sortCode: type: string description: UK sort code routingNumber: type: string description: US ABA routing number iban: type: string description: International Bank Account Number bic: type: string description: BIC/SWIFT code accountHolderName: type: string description: Name on the account bankName: type: string description: Name of the financial institution country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code accountType: type: string description: Account classification, e.g. current, savings required: - type - accountNumber additionalProperties: false uid: type: string additionalProperties: false required: - subject additionalProperties: false data: type: object properties: {} additionalProperties: true required: - instanceId - status - metaData additionalProperties: false examples: InProgress: value: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT status: InProgress metaData: createdTime: 2024-02-15T22:16:33.213Z completedTime: "" data: initiator: admin userIp: 1.1.1.1 dpf: Hello World ednaProfile: DEFAULT ednaStage: "3" Completed: value: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT status: Completed metaData: createdTime: 2024-02-15T22:16:33.213Z completedTime: 2024-02-17T22:16:33.213Z data: initiator: admin userIp: 1.1.1.1 dpf: Hello Mars ednaProfile: DEFAULT ednaStage: "3" "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/task/schema: post: operationId: getTaskSchema summary: Get Task Schema description: Get Task Schema tags: - Customer APIs - Task Service security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: taskId: type: string minLength: 16 maxLength: 64 description: Task Id, a unique identifier for a task assigned to an End User during a Journey. required: - taskId additionalProperties: false example: taskId: TkoviRO58Q8R7qPnAkLAqBAT parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: $schema: type: string type: type: string properties: type: object additionalProperties: {} required: type: array items: type: string required: - $schema - type - properties - required additionalProperties: false examples: Default: value: $schema: http://json-schema.org/draft-07/schema# type: object properties: context: type: object properties: subject: type: object properties: identity: type: object properties: firstName: type: string pattern: "[A-Za-z]+" minLength: 2 required: - firstName required: - identity required: - subject required: - context "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/task/list/schema: post: operationId: getTasksSchema summary: Get Tasks Schema description: Get Tasks Schema tags: - Customer APIs - Task Service security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: false example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT parameters: [] responses: "200": description: Success content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. status: type: string enum: - Completed - InProgress - Failed - Paused tasks: type: array items: type: object properties: taskId: type: string minLength: 16 maxLength: 64 description: Task Id, a unique identifier for a task assigned to an End User during a Journey. schema: type: object properties: $ref: type: string required: - $ref additionalProperties: false required: - taskId - schema additionalProperties: false schemas: type: object additionalProperties: type: object properties: $schema: type: string type: type: string properties: type: object additionalProperties: {} required: type: array items: type: string required: - $schema - type - properties - required additionalProperties: false required: - instanceId - status - tasks - schemas additionalProperties: false examples: Default: value: status: InProgress instanceId: PiIuACmx8Q8R7qPnAkLAqBAT tasks: - taskId: TkoviRO58Q8R7qPnAkLAqBAT schema: $ref: "#/schemas/lo0698Ug9ziO7ZbrEXxjfZxHNaMiK0mn" schemas: lo0698Ug9ziO7ZbrEXxjfZxHNaMiK0mn: $schema: http://json-schema.org/draft-07/schema# type: object properties: context: type: object properties: subject: type: object properties: identity: type: object properties: firstName: type: string minLength: 1 maxLength: 64 required: - context "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/state/delete: post: operationId: deleteInstance summary: Delete instance description: Delete instance tags: - Customer APIs - Instance management security: - CustomerAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: false example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT parameters: [] responses: "200": description: Delete instance response contains the Journey Instance Id content: application/json: schema: type: object properties: instanceId: type: string minLength: 16 maxLength: 64 description: Journey Instance Id, a unique identifier for a started journey instance. required: - instanceId additionalProperties: true description: Delete instance response contains the Journey Instance Id example: instanceId: PiIuACmx8Q8R7qPnAkLAqBAT "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/interaction/submit: post: operationId: submitInteraction summary: Submit Interaction description: Submit Interaction tags: - Interaction Service security: - InteractionAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string description: Journey instance identifier interactionId: type: string description: Interaction identifier participants: type: array items: type: object properties: domainElementId: type: string description: Optional domain element identifier instruction: type: string additionalProperties: false description: List of participant identifiers involved in the interaction context: type: object properties: subject: type: object properties: identity: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false documents: type: array items: type: object properties: oneDBarcode: type: string address: type: object properties: addressString: type: string extractedAddressString: type: string addressLine1: type: string addressLine2: type: string locality: type: string administrativeArea: type: string postalCode: type: string additionalProperties: false applicationDate: type: string applicationNumber: type: string dateOfBirth: type: string placeOfBirth: type: string placeOfBirthNative: type: string bloodType: type: string controlNumber: type: string countryCode: type: string countryName: type: string documentClassCode: type: string documentClassName: type: string documentNumber: type: string documentSignerCertificate: type: string employer: type: string employerAddress: type: string entries: type: string expirationDate: type: string eyeColor: type: string fathersName: type: string fathersNameNative: type: string fathersSurname: type: string firstName: type: string fullName: type: string fullNameNative: type: string givenName: type: string givenNameNative: type: string hairColor: type: string height: type: string issueDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 issuingAuthority: type: string issuingAuthorityNative: type: string issuingStateCode: type: string issuingStateName: type: string licenseClass: type: string licenseEndorsements: type: string licenseRestrictions: type: string mrz: type: string mrz1: type: string mrz2: type: string mrz3: type: string middleName: type: string mothersName: type: string mothersNameNative: type: string mothersSurname: type: string nameSuffix: type: string nationalityCode: type: string nationalityName: type: string nationalityNameNative: type: string occupation: type: string organDonor: type: boolean passportNumber: type: string permitNumber: type: string personalNumber: type: string photo: type: string photoCompressed: type: string photoEncoding: type: string sex: type: string sexNative: type: string signature: type: string signatureCompressed: type: string signatureEncoding: type: string socialSecurityNumber: type: string startDate: type: string surname: type: string surnameNative: type: string visaClass: type: string visaNumber: type: string weight: type: string cardNumber: type: string issuerCountryCode: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code id: type: string type: type: string category: type: string subtype: type: string format: type: string device: type: object properties: type: type: string model: type: string hasContactlessReader: type: boolean hasMagneticStripeReader: type: boolean hasCamera: type: boolean serialNumber: type: string manufacturer: type: string additionalProperties: false side1Image: type: string side2Image: type: string chip: type: object properties: lds: type: array items: type: object properties: name: type: string enum: - COM - SOD - DG1 - DG2 - DG3 - DG4 - DG5 - DG6 - DG7 - DG8 - DG9 - DG10 - DG11 - DG12 - DG13 - DG14 - DG15 data: type: string required: - name - data additionalProperties: true auth: type: array items: type: object properties: type: type: string enum: - ActiveAuthentication - BasicAccessControl - ChipAuthentication - PassiveAuthentication - SupplementalAccessControl - ExtendedAccessControl - TerminalAuthentication result: type: string enum: - Success - Failure - Skipped required: - type - result additionalProperties: true required: - lds - auth additionalProperties: true classification: type: object properties: ids: type: array items: type: string category: type: string type: type: string subtype: type: string isDoubleSided: type: boolean hasNFC: type: boolean year: type: string countryCode: type: string countryName: type: string stateCode: type: string stateName: type: string sides: type: array items: type: object properties: side: type: string id: type: string documentQuality: type: string documentQualityScore: type: number required: - side - id - documentQuality - documentQualityScore additionalProperties: false additionalProperties: false extraction: type: object properties: aggregatedFields: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false extractedFields: type: array items: type: object properties: label: type: string details: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false required: - label - details additionalProperties: false extractedImages: type: array items: type: object properties: label: type: string side: type: string imageID: type: string required: - label - side - imageID additionalProperties: false additionalProperties: false validation: type: object properties: validationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false aggregatedValidationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false additionalProperties: false subType: type: string number: type: string expiryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 subject: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code additionalProperties: false biometrics: type: array items: anyOf: - type: object properties: id: type: string type: type: string face1Image: type: string face2Image: type: string required: - face1Image - face2Image additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string anchorImage: type: string required: - selfieImage - anchorImage additionalProperties: false - type: object properties: id: type: string type: type: string faceImage: type: string required: - faceImage additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string selfieImageEncryption: type: boolean required: - selfieImage additionalProperties: false sessions: type: array items: type: object properties: user: type: object properties: id: type: string email: type: string format: email domain: type: string required: - id - email - domain additionalProperties: false client: type: object properties: id: type: string ip: type: string address: type: string required: - id - ip - address additionalProperties: false device: type: object properties: id: type: string manufacturer: type: string model: type: object properties: identifier: type: string name: type: string required: - identifier - name additionalProperties: false required: - id - manufacturer - model additionalProperties: false trace: type: object properties: id: type: string required: - id additionalProperties: false span: type: object properties: id: type: string required: - id additionalProperties: false transaction: type: object properties: id: type: string required: - id additionalProperties: false auth: type: array items: type: object properties: id: type: string scope: type: string codeVerifier: type: string code: type: string state: type: string redirectUri: type: string responseType: type: string clientId: type: string clientSecret: type: string required: - id additionalProperties: false additionalProperties: false consent: type: array items: allOf: - type: object properties: type: type: string enum: - rollup - explicit - implicit id: type: string version: type: string url: type: string format: uri effectiveDate: type: string expiryDate: type: string terms: type: string purpose: type: string legalBasis: type: string jurisdiction: type: string subject: type: string signatory: type: string additionalProperties: false - type: object properties: url: type: string format: uri required: - url additionalProperties: false accounts: type: array items: type: object properties: type: type: string description: The type of account, e.g. Bank Account, Building Society accountNumber: type: string description: Account number sortCode: type: string description: UK sort code routingNumber: type: string description: US ABA routing number iban: type: string description: International Bank Account Number bic: type: string description: BIC/SWIFT code accountHolderName: type: string description: Name on the account bankName: type: string description: Name of the financial institution country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code accountType: type: string description: Account classification, e.g. current, savings required: - type - accountNumber additionalProperties: false uid: type: string additionalProperties: false required: - subject additionalProperties: false required: - instanceId - interactionId additionalProperties: false example: instanceId: PiKR2O0IjyUR8KV3RviKt4we interactionId: int-456 context: subject: uid: customer-789 participants: - domainElementId: foo instruction: open parameters: [] responses: "200": description: Success content: application/json: schema: anyOf: - type: object properties: status: type: string enum: - success required: - status additionalProperties: false - type: object properties: status: type: string enum: - error code: type: number description: Error code indicating the type of error message: type: string description: Error message detailing the issue required: - status - code - message additionalProperties: false examples: success: value: status: success error: value: status: error code: 500 message: Internal server error "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} /journey/interaction/fetch: post: operationId: fetchInteraction summary: Fetch Interaction description: Fetch Interaction tags: - Interaction Service security: - InteractionAccess: [] requestBody: content: application/json: schema: type: object properties: instanceId: type: string description: Journey instance identifier required: - instanceId additionalProperties: false example: instanceId: PiKR2O0IjyUR8KV3RviKt4we parameters: [] responses: "200": description: Success content: application/json: schema: anyOf: - type: object properties: instanceId: type: string description: Journey instance identifier interactionId: type: string description: Interaction identifier journey: type: object properties: status: type: string enum: - Completed - InProgress - Failed - Paused required: - status additionalProperties: false interaction: type: object properties: resource: type: object properties: id: type: string name: type: string pattern: ^.{1,128}$ hash: type: string pattern: ^[a-zA-Z0-9_/=+-]{1,128}$ version: type: string pattern: ^[a-zA-Z0-9_./=+-]{1,64}$ type: type: string enum: - brand - delivery - flow - form - i18n - journey - license - model - organization - template - interaction data: type: object properties: pages: type: array items: type: object properties: id: type: string label: type: string cards: type: array items: type: object properties: id: type: string version: type: string config: {} required: - id additionalProperties: false required: - id - cards additionalProperties: false required: - pages additionalProperties: false required: - id - name additionalProperties: false collects: type: array items: anyOf: - type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean required: - ref - spec additionalProperties: false - type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean combinator: type: string enum: - oneOf - allOf inputs: type: array items: type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean required: - ref - spec additionalProperties: false required: - ref - spec - combinator - inputs additionalProperties: false consumes: type: array items: anyOf: - type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean required: - ref - spec additionalProperties: false - type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean combinator: type: string enum: - oneOf - allOf inputs: type: array items: type: object properties: ref: type: string spec: type: string enum: - required - optional - conditional recommended: type: boolean required: - ref - spec additionalProperties: false required: - ref - spec - combinator - inputs additionalProperties: false grId: type: string required: - collects - consumes - grId additionalProperties: false context: type: object properties: subject: type: object properties: identity: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false documents: type: array items: type: object properties: oneDBarcode: type: string address: type: object properties: addressString: type: string extractedAddressString: type: string addressLine1: type: string addressLine2: type: string locality: type: string administrativeArea: type: string postalCode: type: string additionalProperties: false applicationDate: type: string applicationNumber: type: string dateOfBirth: type: string placeOfBirth: type: string placeOfBirthNative: type: string bloodType: type: string controlNumber: type: string countryCode: type: string countryName: type: string documentClassCode: type: string documentClassName: type: string documentNumber: type: string documentSignerCertificate: type: string employer: type: string employerAddress: type: string entries: type: string expirationDate: type: string eyeColor: type: string fathersName: type: string fathersNameNative: type: string fathersSurname: type: string firstName: type: string fullName: type: string fullNameNative: type: string givenName: type: string givenNameNative: type: string hairColor: type: string height: type: string issueDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 issuingAuthority: type: string issuingAuthorityNative: type: string issuingStateCode: type: string issuingStateName: type: string licenseClass: type: string licenseEndorsements: type: string licenseRestrictions: type: string mrz: type: string mrz1: type: string mrz2: type: string mrz3: type: string middleName: type: string mothersName: type: string mothersNameNative: type: string mothersSurname: type: string nameSuffix: type: string nationalityCode: type: string nationalityName: type: string nationalityNameNative: type: string occupation: type: string organDonor: type: boolean passportNumber: type: string permitNumber: type: string personalNumber: type: string photo: type: string photoCompressed: type: string photoEncoding: type: string sex: type: string sexNative: type: string signature: type: string signatureCompressed: type: string signatureEncoding: type: string socialSecurityNumber: type: string startDate: type: string surname: type: string surnameNative: type: string visaClass: type: string visaNumber: type: string weight: type: string cardNumber: type: string issuerCountryCode: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code id: type: string type: type: string category: type: string subtype: type: string format: type: string device: type: object properties: type: type: string model: type: string hasContactlessReader: type: boolean hasMagneticStripeReader: type: boolean hasCamera: type: boolean serialNumber: type: string manufacturer: type: string additionalProperties: false side1Image: type: string side2Image: type: string chip: type: object properties: lds: type: array items: type: object properties: name: type: string enum: - COM - SOD - DG1 - DG2 - DG3 - DG4 - DG5 - DG6 - DG7 - DG8 - DG9 - DG10 - DG11 - DG12 - DG13 - DG14 - DG15 data: type: string required: - name - data additionalProperties: true auth: type: array items: type: object properties: type: type: string enum: - ActiveAuthentication - BasicAccessControl - ChipAuthentication - PassiveAuthentication - SupplementalAccessControl - ExtendedAccessControl - TerminalAuthentication result: type: string enum: - Success - Failure - Skipped required: - type - result additionalProperties: true required: - lds - auth additionalProperties: true classification: type: object properties: ids: type: array items: type: string category: type: string type: type: string subtype: type: string isDoubleSided: type: boolean hasNFC: type: boolean year: type: string countryCode: type: string countryName: type: string stateCode: type: string stateName: type: string sides: type: array items: type: object properties: side: type: string id: type: string documentQuality: type: string documentQualityScore: type: number required: - side - id - documentQuality - documentQualityScore additionalProperties: false additionalProperties: false extraction: type: object properties: aggregatedFields: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false extractedFields: type: array items: type: object properties: label: type: string details: type: array items: type: object properties: label: type: string value: type: string source: type: string isNonLatin: type: boolean regionOfInterest: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false required: - label - value - source - isNonLatin additionalProperties: false required: - label - details additionalProperties: false extractedImages: type: array items: type: object properties: label: type: string side: type: string imageID: type: string required: - label - side - imageID additionalProperties: false additionalProperties: false validation: type: object properties: validationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false aggregatedValidationChecks: type: array items: type: object properties: name: type: string title: type: string info: type: string validationResult: type: string resultInfo: type: string weight: type: string regionOfInterests: type: array items: type: object properties: boundingBox: type: object properties: x: type: number y: type: number width: type: number height: type: number required: - x - y - width - height additionalProperties: false side: type: string spectrum: type: string imageId: type: string required: - side additionalProperties: false type: type: string required: - name - title - info - validationResult - resultInfo - weight - type additionalProperties: false additionalProperties: false subType: type: string number: type: string expiryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 subject: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual aliases: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual additionalProperties: false relatedPersons: type: array items: type: object properties: title: type: string description: Title of an individual such as Mr, Mrs, Dr, Sir firstName: type: string description: A person's name used by their collegues and friends to address them middleNames: type: array items: type: string description: Any other registered names used by the individual, not aliases lastNames: type: array items: type: string description: Any family names for the individual lastNamesAtBirth: type: array items: type: string description: Any family names for the individual relationship: type: string enum: - mother - father - maternalGrandFather - maternalGrandMother - paternalGrandFather - paternalGrandMother required: - relationship additionalProperties: false dateOfBirth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 gender: type: string currentAddress: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false previousAddresses: type: array items: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false fromDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 toDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601 required: - fromDate - toDate additionalProperties: false placeOfBirth: type: object properties: lines: type: array items: type: string description: Unformatted line based address addressString: type: string description: The address as a single line premise: type: string description: "The primary delivery point for a premise or building. This could be a house number, a building name, etc. " building: type: string description: The name of a building or a building complex. In the US, this is the street number. subBuilding: type: string description: The name of a sub-building, such as a flat or apartment number. thoroughfare: type: string description: This field holds the most common street or block data element within a country. For instance, USA Street dependentThoroughfare: type: string description: The name of a dependent street or block, such as a street within a complex. locality: type: string description: This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality dependentLocality: type: string description: This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London. doubleDependentLocality: type: string description: This is an even smaller area within a dependent locality, often used in very detailed addresses. postalCode: type: string description: This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US postBox: type: string description: This field contains the post box number associated with a particular delivery point, should one exist. country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code superAdministrativeArea: type: string administrativeArea: type: string subAdministrativeArea: type: string organization: type: string location: type: object properties: latitude: type: string longitude: type: string geoAccuracy: type: string what3words: type: string description: A What3words designation associated with this location with '.' separator. additionalProperties: false additionalProperties: false idNumbers: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc idNumber: type: string description: ID number eg, National Insurance Number in UK, Social Securtiy Number in US country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code required: - type - idNumber additionalProperties: false phones: type: array items: type: object properties: type: type: string description: The type of phone number, such as landline, mobile, fax, unknown etc number: type: string description: Phone number, ideally in international format with +(Country Code) required: - type - number additionalProperties: false emails: type: array items: type: object properties: type: type: string description: The type of email, such as home, work, unknown etc email: type: string description: Email address required: - type - email additionalProperties: false socials: type: array items: type: object properties: type: type: string description: An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc identity: type: string description: the identity used on this platform required: - type - identity additionalProperties: false mothersMaidenName: type: string description: The subject's mother's maiden name, used for identity verification additionalProperties: false country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code additionalProperties: false biometrics: type: array items: anyOf: - type: object properties: id: type: string type: type: string face1Image: type: string face2Image: type: string required: - face1Image - face2Image additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string anchorImage: type: string required: - selfieImage - anchorImage additionalProperties: false - type: object properties: id: type: string type: type: string faceImage: type: string required: - faceImage additionalProperties: false - type: object properties: id: type: string type: type: string selfieImage: type: string selfieImageEncryption: type: boolean required: - selfieImage additionalProperties: false sessions: type: array items: type: object properties: user: type: object properties: id: type: string email: type: string format: email domain: type: string required: - id - email - domain additionalProperties: false client: type: object properties: id: type: string ip: type: string address: type: string required: - id - ip - address additionalProperties: false device: type: object properties: id: type: string manufacturer: type: string model: type: object properties: identifier: type: string name: type: string required: - identifier - name additionalProperties: false required: - id - manufacturer - model additionalProperties: false trace: type: object properties: id: type: string required: - id additionalProperties: false span: type: object properties: id: type: string required: - id additionalProperties: false transaction: type: object properties: id: type: string required: - id additionalProperties: false auth: type: array items: type: object properties: id: type: string scope: type: string codeVerifier: type: string code: type: string state: type: string redirectUri: type: string responseType: type: string clientId: type: string clientSecret: type: string required: - id additionalProperties: false additionalProperties: false consent: type: array items: allOf: - type: object properties: type: type: string enum: - rollup - explicit - implicit id: type: string version: type: string url: type: string format: uri effectiveDate: type: string expiryDate: type: string terms: type: string purpose: type: string legalBasis: type: string jurisdiction: type: string subject: type: string signatory: type: string additionalProperties: false - type: object properties: url: type: string format: uri required: - url additionalProperties: false accounts: type: array items: type: object properties: type: type: string description: The type of account, e.g. Bank Account, Building Society accountNumber: type: string description: Account number sortCode: type: string description: UK sort code routingNumber: type: string description: US ABA routing number iban: type: string description: International Bank Account Number bic: type: string description: BIC/SWIFT code accountHolderName: type: string description: Name on the account bankName: type: string description: Name of the financial institution country: type: string pattern: ^[A-Z]{2,3}$ description: Country the address is in. It must be a valid ISO2 or ISO3 country code accountType: type: string description: Account classification, e.g. current, savings required: - type - accountNumber additionalProperties: false uid: type: string additionalProperties: false additionalProperties: false instructions: type: array items: type: string outstanding: type: array items: type: string required: - instanceId - interactionId - journey - interaction additionalProperties: false - type: object properties: status: type: string enum: - error code: type: number description: Error code indicating the type of error message: type: string description: Error message detailing the issue required: - status - code - message additionalProperties: false - type: object properties: instanceId: type: string description: Journey instance identifier journey: type: object properties: status: type: string enum: - Completed - InProgress - Failed - Paused required: - status additionalProperties: false processing: type: boolean description: >- True when the journey is still working and no interaction is available yet. Clients should poll /journey/interaction/fetch until this is absent/false and an `interaction` is returned. required: - instanceId - journey additionalProperties: false examples: success: value: instanceId: PiKR2O0IjyUR8KV3RviKt4we interactionId: int-456 journey: status: InProgress interaction: collects: [] consumes: [] resource: id: identity-form-v1 name: Identity Verification Form type: form version: "1.0" data: pages: - id: page-1 label: Personal Info cards: - id: name-card version: "1.0" - id: email-card version: "1.0" grId: interaction-001 context: {} error: value: status: error code: 500 message: Internal server error processing: value: instanceId: PiKR2O0IjyUR8KV3RviKt4we journey: status: InProgress processing: true "400": description: Bad Request content: application/json: {} "401": description: Unauthorized content: application/json: {} "403": description: Forbidden content: application/json: {} "404": description: Not Found content: application/json: {} "405": description: Method Not Allowed content: application/json: {} "500": description: Internal Server Error content: application/json: {} "503": description: Service Unavailable content: application/json: {} components: schemas: PasswordGrantRequest: type: object properties: client_id: type: string description: The client ID assigned to your organization. client_secret: type: string description: The client secret assigned to your organization. username: type: string description: The username for API authentication. password: type: string description: The password for API authentication. grant_type: type: string enum: - password description: Must always be set to 'password'. required: - client_id - client_secret - username - password - grant_type ClientCredentialsGrantRequest: type: object properties: client_id: type: string description: The client ID assigned to your organization. client_secret: type: string description: The client secret assigned to your organization. grant_type: type: string enum: - client_credentials description: Must always be set to 'client_credentials'. required: - client_id - client_secret - grant_type securitySchemes: CustomerAccess: type: http scheme: bearer bearerFormat: JWT DeviceConnect: type: http scheme: bearer bearerFormat: JWT PingID: type: http scheme: bearer bearerFormat: JWT InteractionAccess: type: http scheme: bearer bearerFormat: JWT tags: - name: Health - name: Customer APIs - name: Flow Dispatch Service - name: One Time Token Service - name: Task Service - name: Instance management - name: Interaction Service - name: End User APIs