Corporate - Step Details

GET 
/v4/corporate/session/:session_id/step/:step_id

Respond with the step details of a session. The response depend on the step type.

Request

Path Parameters

session_id stringrequired
step_id stringrequired

Responses

200

200 response

application/json

Schema

Schema

oneOf

LegalRepresentativeDetailsResponse

authorization

object

required

file

object

required

size integerrequired

type stringrequired

url stringrequired

required booleanrequired

birth_date stringrequired

firstname stringrequired

id stringrequired

lastname stringrequired

nationality stringrequired

status stringrequired

steps

object[]

required

Array [

id string

status stringrequired

type stringrequired

]

DocumentDetailsResponse

files

object[]

required

Array [

size integerrequired

type stringrequired

url stringrequired

]

status stringrequired

CompanyDetailsResponse

address stringrequired

city stringrequired

country stringrequired

name stringrequired

registration_number stringrequired

zipcode stringrequired

BeneficialOwnersDetailsResponse

corporates

object[]

required

Array [

aml

object

required

action_required booleanrequired

decision

object

required

Reasons

object[]

required

Array [

note stringrequired

reason stringrequired

]

compliance_officer stringrequired

internal_note stringrequired

output stringrequired

user_id stringrequired

matches integerrequired

monitoring booleanrequired

screening

object[]

required

Array [

adverse_media

object[]

required

Array [

date stringrequired

snippet stringrequired

title stringrequired

url stringrequired

]

id stringrequired

info

object

required

aka string[]required

associates

object[]

required

Array [

association stringrequired

name stringrequired

]

birth_date stringrequired

countries stringrequired

entity_type stringrequired

full_name stringrequired

pep

object[]

required

Array [

countries

object[]

required

Array [

country_code stringrequired

name stringrequired

]

fields

object[]

required

Array [

name stringrequired

value stringrequired

]

listing_ended stringrequired

listing_started stringrequired

name stringrequired

types string[]required

url stringrequired

]

sanctions

object[]

required

Array [

countries

object[]

required

Array [

country_code stringrequired

name stringrequired

]

fields

object[]

required

Array [

name stringrequired

value stringrequired

]

listing_ended stringrequired

listing_started stringrequired

name stringrequired

types string[]required

url stringrequired

]

types string[]required

]

status stringrequired

company_details

object

required

address stringrequired

city stringrequired

country stringrequired

name stringrequired

registration_number stringrequired

zipcode stringrequired

documents

object

required

property name*

DocumentDetailsResponse

files

object[]

required

Array [

size integerrequired

type stringrequired

url stringrequired

]

status stringrequired

edges

object[]

required

Array [

director booleanrequired

node_id integerrequired

shares numberrequired

]

node_id integerrequired

]

individuals

object[]

required

Array [

birth_date stringrequired

edges

object[]

required

Array [

director booleanrequired

node_id integerrequired

shares numberrequired

]

firstname stringrequired

id stringrequired

lastname stringrequired

nationality stringrequired

node_id integerrequired

status stringrequired

steps

object[]

required

Array [

id string

status stringrequired

type stringrequired

]

ultimate booleanrequired

]

AmlDetailsResponse

action_required booleanrequired

decision

object

required

Reasons

object[]

required

Array [

note stringrequired

reason stringrequired

]

compliance_officer stringrequired

internal_note stringrequired

output stringrequired

user_id stringrequired

matches integerrequired

monitoring booleanrequired

screening

object[]

required

Array [

adverse_media

object[]

required

Array [

date stringrequired

snippet stringrequired

title stringrequired

url stringrequired

]

id stringrequired

info

object

required

aka string[]required

associates

object[]

required

Array [

association stringrequired

name stringrequired

]

birth_date stringrequired

countries stringrequired

entity_type stringrequired

full_name stringrequired

pep

object[]

required

Array [

countries

object[]

required

Array [

country_code stringrequired

name stringrequired

]

fields

object[]

required

Array [

name stringrequired

value stringrequired

]

listing_ended stringrequired

listing_started stringrequired

name stringrequired

types string[]required

url stringrequired

]

sanctions

object[]

required

Array [

countries

object[]

required

Array [

country_code stringrequired

name stringrequired

]

fields

object[]

required

Array [

name stringrequired

value stringrequired

]

listing_ended stringrequired

listing_started stringrequired

name stringrequired

types string[]required

url stringrequired

]

types string[]required

]

status stringrequired

Example (from schema)

{}

400

400 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

401

401 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

404

404 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

500

500 response

application/json

Schema

Schema

code int32
message string

Example (from schema)

{
  "code": 1100220,
  "message": "An error occured"
}

Loading...