Jump to

• Request
• Response

Perform adhoc Restricted Party Screening

post

/custom-actions/adhocRPS

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• gtmServicePreferenceId: string
  The gtmServicePreferenceId to which the restricted party screening should occur.
• party: object party
• restrictedPartyListRequired: string
  If this is set to true, then the response will return top 5 matching restricted parties if present in the response.

{
    "properties":{
        "gtmServicePreferenceId":{
            "type":"string",
            "description":"The gtmServicePreferenceId to which the restricted party screening should occur."
        },
        "party":{
            "type":"object",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"First name of the party or individual."
                },
                "lastName":{
                    "type":"string",
                    "description":"Last name of the party or individual."
                },
                "companyName":{
                    "type":"string",
                    "description":"Name of the company associated with the party."
                },
                "addressLine1":{
                    "type":"string",
                    "description":"Primary address line of the party."
                },
                "addressLine2":{
                    "type":"string",
                    "description":"Secondary address line (optional)."
                },
                "addressLine3":{
                    "type":"string",
                    "description":"Tertiary address line (optional)."
                },
                "city":{
                    "type":"string",
                    "description":"City where the party is located."
                },
                "province":{
                    "type":"string",
                    "description":"State or province where the party is located."
                },
                "country":{
                    "type":"string",
                    "description":"Country of the party's address."
                },
                "postalCode":{
                    "type":"string",
                    "description":"Postal or ZIP code of the party's address."
                }
            }
        },
        "restrictedPartyListRequired":{
            "type":"string",
            "description":"If this is set to true, then the response will return top 5 matching restricted parties if present in the response."
        }
    }
}

Nested Schema : party

Type: object

Show Source

• addressLine1: string
  Primary address line of the party.
• addressLine2: string
  Secondary address line (optional).
• addressLine3: string
  Tertiary address line (optional).
• city: string
  City where the party is located.
• companyName: string
  Name of the company associated with the party.
• country: string
  Country of the party's address.
• firstName: string
  First name of the party or individual.
• lastName: string
  Last name of the party or individual.
• postalCode: string
  Postal or ZIP code of the party's address.
• province: string
  State or province where the party is located.

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of the party or individual."
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the party or individual."
        },
        "companyName":{
            "type":"string",
            "description":"Name of the company associated with the party."
        },
        "addressLine1":{
            "type":"string",
            "description":"Primary address line of the party."
        },
        "addressLine2":{
            "type":"string",
            "description":"Secondary address line (optional)."
        },
        "addressLine3":{
            "type":"string",
            "description":"Tertiary address line (optional)."
        },
        "city":{
            "type":"string",
            "description":"City where the party is located."
        },
        "province":{
            "type":"string",
            "description":"State or province where the party is located."
        },
        "country":{
            "type":"string",
            "description":"Country of the party's address."
        },
        "postalCode":{
            "type":"string",
            "description":"Postal or ZIP code of the party's address."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success! A successful POST method returns a 200 status code.

Body ()

Root Schema : adhocRPSResponse

Type: object

The response body contains the request body in the response along with status parameter along with list of restricted parties (at most 5 with highest match factor).

Show Source

• adhocRPSRequest: schema
• restrictedPartyList: array restrictedPartyList
  List of 5 restricted parties with relevant details.
• status: string
  The response status indicating whether party details has any matching denied parties. If no match has been found then fail and if it is found then pass.

{
    "type":"object",
    "description":"The response body contains the request body in the response along with status parameter along with list of restricted parties (at most 5 with highest match factor). ",
    "properties":{
        "adhocRPSRequest":{
            "$ref":"#/components/schemas/adhocRPSRequest"
        },
        "status":{
            "type":"string",
            "description":"The response status indicating whether party details has any matching denied parties. If no match has been found then fail and if it is found then pass."
        },
        "restrictedPartyList":{
            "type":"array",
            "description":"List of 5 restricted parties with relevant details.",
            "items":{
                "type":"object",
                "properties":{
                    "gtmDeniedPartyGid":{
                        "type":"string",
                        "description":"Unique identifier for the GTM denied party."
                    },
                    "firstName":{
                        "type":"string",
                        "description":"First name of the restricted party individual."
                    },
                    "lastName":{
                        "type":"string",
                        "description":"Last name of the restricted party individual."
                    },
                    "companyName":{
                        "type":"string",
                        "description":"Company name associated with the restricted party."
                    },
                    "addressLine1":{
                        "type":"string",
                        "description":"Primary address line of the restricted party."
                    },
                    "addressLine2":{
                        "type":"string",
                        "description":"Secondary address line of the restricted party (if applicable)."
                    },
                    "addressLine3":{
                        "type":"string",
                        "description":"Tertiary address line of the restricted party (if applicable)."
                    },
                    "city":{
                        "type":"string",
                        "description":"City where the restricted party is located."
                    },
                    "province":{
                        "type":"string",
                        "description":"Province or state of the restricted party."
                    },
                    "country":{
                        "type":"string",
                        "description":"Country where the restricted party is located."
                    },
                    "postalCode":{
                        "type":"string",
                        "description":"Postal or ZIP code of the restricted party's address."
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date when the restriction became effective (YYYY-MM-DD)."
                    },
                    "expirationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date when the restriction expires (YYYY-MM-DD)."
                    },
                    "entryId":{
                        "type":"string",
                        "description":"Entry ID associated with the restricted party listing."
                    },
                    "agencyCode":{
                        "type":"string",
                        "description":"Code representing the agency that issued the restriction."
                    },
                    "matchPer":{
                        "type":"string",
                        "description":"Match percentage indicating the percentage of matching of the restricted party with party details."
                    }
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• gtmServicePreferenceId: string
  The gtmServicePreferenceId to which the restricted party screening should occur.
• party: object party
• restrictedPartyListRequired: string
  If this is set to true, then the response will return top 5 matching restricted parties if present in the response.

{
    "properties":{
        "gtmServicePreferenceId":{
            "type":"string",
            "description":"The gtmServicePreferenceId to which the restricted party screening should occur."
        },
        "party":{
            "type":"object",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"First name of the party or individual."
                },
                "lastName":{
                    "type":"string",
                    "description":"Last name of the party or individual."
                },
                "companyName":{
                    "type":"string",
                    "description":"Name of the company associated with the party."
                },
                "addressLine1":{
                    "type":"string",
                    "description":"Primary address line of the party."
                },
                "addressLine2":{
                    "type":"string",
                    "description":"Secondary address line (optional)."
                },
                "addressLine3":{
                    "type":"string",
                    "description":"Tertiary address line (optional)."
                },
                "city":{
                    "type":"string",
                    "description":"City where the party is located."
                },
                "province":{
                    "type":"string",
                    "description":"State or province where the party is located."
                },
                "country":{
                    "type":"string",
                    "description":"Country of the party's address."
                },
                "postalCode":{
                    "type":"string",
                    "description":"Postal or ZIP code of the party's address."
                }
            }
        },
        "restrictedPartyListRequired":{
            "type":"string",
            "description":"If this is set to true, then the response will return top 5 matching restricted parties if present in the response."
        }
    }
}

Nested Schema : restrictedPartyList

Type: array

List of 5 restricted parties with relevant details.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"List of 5 restricted parties with relevant details.",
    "items":{
        "type":"object",
        "properties":{
            "gtmDeniedPartyGid":{
                "type":"string",
                "description":"Unique identifier for the GTM denied party."
            },
            "firstName":{
                "type":"string",
                "description":"First name of the restricted party individual."
            },
            "lastName":{
                "type":"string",
                "description":"Last name of the restricted party individual."
            },
            "companyName":{
                "type":"string",
                "description":"Company name associated with the restricted party."
            },
            "addressLine1":{
                "type":"string",
                "description":"Primary address line of the restricted party."
            },
            "addressLine2":{
                "type":"string",
                "description":"Secondary address line of the restricted party (if applicable)."
            },
            "addressLine3":{
                "type":"string",
                "description":"Tertiary address line of the restricted party (if applicable)."
            },
            "city":{
                "type":"string",
                "description":"City where the restricted party is located."
            },
            "province":{
                "type":"string",
                "description":"Province or state of the restricted party."
            },
            "country":{
                "type":"string",
                "description":"Country where the restricted party is located."
            },
            "postalCode":{
                "type":"string",
                "description":"Postal or ZIP code of the restricted party's address."
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Date when the restriction became effective (YYYY-MM-DD)."
            },
            "expirationDate":{
                "type":"string",
                "format":"date",
                "description":"Date when the restriction expires (YYYY-MM-DD)."
            },
            "entryId":{
                "type":"string",
                "description":"Entry ID associated with the restricted party listing."
            },
            "agencyCode":{
                "type":"string",
                "description":"Code representing the agency that issued the restriction."
            },
            "matchPer":{
                "type":"string",
                "description":"Match percentage indicating the percentage of matching of the restricted party with party details."
            }
        }
    }
}

Nested Schema : party

Type: object

Show Source

• addressLine1: string
  Primary address line of the party.
• addressLine2: string
  Secondary address line (optional).
• addressLine3: string
  Tertiary address line (optional).
• city: string
  City where the party is located.
• companyName: string
  Name of the company associated with the party.
• country: string
  Country of the party's address.
• firstName: string
  First name of the party or individual.
• lastName: string
  Last name of the party or individual.
• postalCode: string
  Postal or ZIP code of the party's address.
• province: string
  State or province where the party is located.

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"First name of the party or individual."
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the party or individual."
        },
        "companyName":{
            "type":"string",
            "description":"Name of the company associated with the party."
        },
        "addressLine1":{
            "type":"string",
            "description":"Primary address line of the party."
        },
        "addressLine2":{
            "type":"string",
            "description":"Secondary address line (optional)."
        },
        "addressLine3":{
            "type":"string",
            "description":"Tertiary address line (optional)."
        },
        "city":{
            "type":"string",
            "description":"City where the party is located."
        },
        "province":{
            "type":"string",
            "description":"State or province where the party is located."
        },
        "country":{
            "type":"string",
            "description":"Country of the party's address."
        },
        "postalCode":{
            "type":"string",
            "description":"Postal or ZIP code of the party's address."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• addressLine1: string
  Primary address line of the restricted party.
• addressLine2: string
  Secondary address line of the restricted party (if applicable).
• addressLine3: string
  Tertiary address line of the restricted party (if applicable).
• agencyCode: string
  Code representing the agency that issued the restriction.
• city: string
  City where the restricted party is located.
• companyName: string
  Company name associated with the restricted party.
• country: string
  Country where the restricted party is located.
• effectiveDate: string (date)
  Date when the restriction became effective (YYYY-MM-DD).
• entryId: string
  Entry ID associated with the restricted party listing.
• expirationDate: string (date)
  Date when the restriction expires (YYYY-MM-DD).
• firstName: string
  First name of the restricted party individual.
• gtmDeniedPartyGid: string
  Unique identifier for the GTM denied party.
• lastName: string
  Last name of the restricted party individual.
• matchPer: string
  Match percentage indicating the percentage of matching of the restricted party with party details.
• postalCode: string
  Postal or ZIP code of the restricted party's address.
• province: string
  Province or state of the restricted party.

{
    "type":"object",
    "properties":{
        "gtmDeniedPartyGid":{
            "type":"string",
            "description":"Unique identifier for the GTM denied party."
        },
        "firstName":{
            "type":"string",
            "description":"First name of the restricted party individual."
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the restricted party individual."
        },
        "companyName":{
            "type":"string",
            "description":"Company name associated with the restricted party."
        },
        "addressLine1":{
            "type":"string",
            "description":"Primary address line of the restricted party."
        },
        "addressLine2":{
            "type":"string",
            "description":"Secondary address line of the restricted party (if applicable)."
        },
        "addressLine3":{
            "type":"string",
            "description":"Tertiary address line of the restricted party (if applicable)."
        },
        "city":{
            "type":"string",
            "description":"City where the restricted party is located."
        },
        "province":{
            "type":"string",
            "description":"Province or state of the restricted party."
        },
        "country":{
            "type":"string",
            "description":"Country where the restricted party is located."
        },
        "postalCode":{
            "type":"string",
            "description":"Postal or ZIP code of the restricted party's address."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Date when the restriction became effective (YYYY-MM-DD)."
        },
        "expirationDate":{
            "type":"string",
            "format":"date",
            "description":"Date when the restriction expires (YYYY-MM-DD)."
        },
        "entryId":{
            "type":"string",
            "description":"Entry ID associated with the restricted party listing."
        },
        "agencyCode":{
            "type":"string",
            "description":"Code representing the agency that issued the restriction."
        },
        "matchPer":{
            "type":"string",
            "description":"Match percentage indicating the percentage of matching of the restricted party with party details."
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

429 Response

Indicates that the client has sent too many requests to the server at any given point of time. The maximum number of allowed concurrent requests is a configurable property.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top