Jump to

• Request
• Response

Create a Restricted Party

post

/restrictedPartys

Request

Header Parameters

• Prefer: string
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• addressLine1: string
  No description.
• addressLine2: string
  No description.
• addressLine3: string
  No description.
• agencyCode: string
  No description.
• altPassportIssuingCountry: string
  No description.
• altPassportIssuingDate: string
  No description.
• altPassportNumber: string
  No description.
• cedula: string
  No description.
• citizenship: string
  No description.
• city: string
  No description.
• companyName: string
  No description.
• country: string
  No description.
• countryCode: string
  No description.
• dateOfBirth: string
  No description.
• denialCode: string
  No description.
• domainName: string
  No description.
• driverLicenseAuthority: string
  No description.
• driverLicenseNumber: string
  No description.
• effectiveDate: effectiveDate
  No description.
• entryDate: entryDate
  No description.
• entryId: string
  No description.
• expirationDate: expirationDate
  No description.
• federalRegulationDate: federalRegulationDate
  No description.
• federalRegulationUrl: string
  No description.
• firstName: string
  No description.
• gtmDataVersionGid: string
  No description.
• gtmDeniedPartyGid: string
  No description.
• gtmDeniedPartyXid: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• isInuse: boolean
  No description.
• lastName: string
  No description.
• links: array links
  Read Only: true
• nationality: string
  No description.
• nit: string
  No description.
• notes: string
  No description.
• passportIssuingCountry: string
  No description.
• passportIssuingDate: string
  No description.
• passportNumber: string
  No description.
• placeOfBirth: string
  No description.
• postalCode: string
  No description.
• province: string
  No description.
• rulingPageNumber: string
  No description.
• rulingVolume: string
  No description.
• screeningStatus: string
  No description.
• ssn: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• vesselName: string
  No description.

{
    "properties":{
        "gtmDeniedPartyGid":{
            "description":"No description.",
            "type":"string"
        },
        "gtmDeniedPartyXid":{
            "description":"No description.",
            "type":"string"
        },
        "firstName":{
            "description":"No description.",
            "type":"string"
        },
        "lastName":{
            "description":"No description.",
            "type":"string"
        },
        "companyName":{
            "description":"No description.",
            "type":"string"
        },
        "vesselName":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine1":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine2":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine3":{
            "description":"No description.",
            "type":"string"
        },
        "city":{
            "description":"No description.",
            "type":"string"
        },
        "province":{
            "description":"No description.",
            "type":"string"
        },
        "postalCode":{
            "description":"No description.",
            "type":"string"
        },
        "country":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dateOfBirth":{
            "description":"No description.",
            "type":"string"
        },
        "placeOfBirth":{
            "description":"No description.",
            "type":"string"
        },
        "passportNumber":{
            "description":"No description.",
            "type":"string"
        },
        "passportIssuingCountry":{
            "description":"No description.",
            "type":"string"
        },
        "passportIssuingDate":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportNumber":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportIssuingCountry":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportIssuingDate":{
            "description":"No description.",
            "type":"string"
        },
        "driverLicenseNumber":{
            "description":"No description.",
            "type":"string"
        },
        "driverLicenseAuthority":{
            "description":"No description.",
            "type":"string"
        },
        "citizenship":{
            "description":"No description.",
            "type":"string"
        },
        "nationality":{
            "description":"No description.",
            "type":"string"
        },
        "ssn":{
            "description":"No description.",
            "type":"string"
        },
        "nit":{
            "description":"No description.",
            "type":"string"
        },
        "cedula":{
            "description":"No description.",
            "type":"string"
        },
        "denialCode":{
            "description":"No description.",
            "type":"string"
        },
        "entryDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "entryId":{
            "description":"No description.",
            "type":"string"
        },
        "agencyCode":{
            "description":"No description.",
            "type":"string"
        },
        "rulingVolume":{
            "description":"No description.",
            "type":"string"
        },
        "rulingPageNumber":{
            "description":"No description.",
            "type":"string"
        },
        "federalRegulationDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "notes":{
            "description":"No description.",
            "type":"string"
        },
        "gtmDataVersionGid":{
            "description":"No description.",
            "type":"string"
        },
        "isInuse":{
            "description":"No description.",
            "type":"boolean"
        },
        "screeningStatus":{
            "description":"No description.",
            "type":"string"
        },
        "federalRegulationUrl":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "countryCode":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : entryDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : federalRegulationDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• addressLine1: string
  No description.
• addressLine2: string
  No description.
• addressLine3: string
  No description.
• agencyCode: string
  No description.
• altPassportIssuingCountry: string
  No description.
• altPassportIssuingDate: string
  No description.
• altPassportNumber: string
  No description.
• cedula: string
  No description.
• citizenship: string
  No description.
• city: string
  No description.
• companyName: string
  No description.
• country: string
  No description.
• countryCode: string
  No description.
• dateOfBirth: string
  No description.
• denialCode: string
  No description.
• domainName: string
  No description.
• driverLicenseAuthority: string
  No description.
• driverLicenseNumber: string
  No description.
• effectiveDate: effectiveDate
  No description.
• entryDate: entryDate
  No description.
• entryId: string
  No description.
• expirationDate: expirationDate
  No description.
• federalRegulationDate: federalRegulationDate
  No description.
• federalRegulationUrl: string
  No description.
• firstName: string
  No description.
• gtmDataVersionGid: string
  No description.
• gtmDeniedPartyGid: string
  No description.
• gtmDeniedPartyXid: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• isInuse: boolean
  No description.
• lastName: string
  No description.
• links: array links
  Read Only: true
• nationality: string
  No description.
• nit: string
  No description.
• notes: string
  No description.
• passportIssuingCountry: string
  No description.
• passportIssuingDate: string
  No description.
• passportNumber: string
  No description.
• placeOfBirth: string
  No description.
• postalCode: string
  No description.
• province: string
  No description.
• rulingPageNumber: string
  No description.
• rulingVolume: string
  No description.
• screeningStatus: string
  No description.
• ssn: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• vesselName: string
  No description.

{
    "properties":{
        "gtmDeniedPartyGid":{
            "description":"No description.",
            "type":"string"
        },
        "gtmDeniedPartyXid":{
            "description":"No description.",
            "type":"string"
        },
        "firstName":{
            "description":"No description.",
            "type":"string"
        },
        "lastName":{
            "description":"No description.",
            "type":"string"
        },
        "companyName":{
            "description":"No description.",
            "type":"string"
        },
        "vesselName":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine1":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine2":{
            "description":"No description.",
            "type":"string"
        },
        "addressLine3":{
            "description":"No description.",
            "type":"string"
        },
        "city":{
            "description":"No description.",
            "type":"string"
        },
        "province":{
            "description":"No description.",
            "type":"string"
        },
        "postalCode":{
            "description":"No description.",
            "type":"string"
        },
        "country":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dateOfBirth":{
            "description":"No description.",
            "type":"string"
        },
        "placeOfBirth":{
            "description":"No description.",
            "type":"string"
        },
        "passportNumber":{
            "description":"No description.",
            "type":"string"
        },
        "passportIssuingCountry":{
            "description":"No description.",
            "type":"string"
        },
        "passportIssuingDate":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportNumber":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportIssuingCountry":{
            "description":"No description.",
            "type":"string"
        },
        "altPassportIssuingDate":{
            "description":"No description.",
            "type":"string"
        },
        "driverLicenseNumber":{
            "description":"No description.",
            "type":"string"
        },
        "driverLicenseAuthority":{
            "description":"No description.",
            "type":"string"
        },
        "citizenship":{
            "description":"No description.",
            "type":"string"
        },
        "nationality":{
            "description":"No description.",
            "type":"string"
        },
        "ssn":{
            "description":"No description.",
            "type":"string"
        },
        "nit":{
            "description":"No description.",
            "type":"string"
        },
        "cedula":{
            "description":"No description.",
            "type":"string"
        },
        "denialCode":{
            "description":"No description.",
            "type":"string"
        },
        "entryDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "entryId":{
            "description":"No description.",
            "type":"string"
        },
        "agencyCode":{
            "description":"No description.",
            "type":"string"
        },
        "rulingVolume":{
            "description":"No description.",
            "type":"string"
        },
        "rulingPageNumber":{
            "description":"No description.",
            "type":"string"
        },
        "federalRegulationDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "notes":{
            "description":"No description.",
            "type":"string"
        },
        "gtmDataVersionGid":{
            "description":"No description.",
            "type":"string"
        },
        "isInuse":{
            "description":"No description.",
            "type":"boolean"
        },
        "screeningStatus":{
            "description":"No description.",
            "type":"string"
        },
        "federalRegulationUrl":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "countryCode":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : entryDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : federalRegulationDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top