SmartSignPlusPackageStatus

Overview

This method is used to retrieve the status of a SmartSign Plus package.

Table 1. Method
Method URL Description
POST /api/v1/Document/account/{accountId}/SmartSignPlusPackageStatus The POST method submits the accountId as part of the SmartSignPlusPackageStatus call
Table 2. Request Parameters
Name Type Constraints Description
accountId integer required The account used to associate to the request.
packageId string Required The unique identifier for the specific package.

Sample Request


{
  "packageId": "5wRS8HZ8cl602dL5ApLnC"
}

Sample Response


{
    "id": "BaMQXdg5hho7g7bwZ1zRi",
    "shortId": "d17d5799e26eb",
    "vaultId": 28119656,
    "version": 14,
    "name": "PKG.Mortgage2",
    "status": "AVAILABLE_TO_SIGNERS",
    "createdAt": "2024-05-23T16:59:17.696Z",
    "createdBy": "4XdARtqGU2QCOW2YbvKQGt",
    "packageGroups": [
        {
            "uid": "2itN2oPwNcOivVLvV8boRy",
            "name": "Org Admin"
        }
    ],
    "sendToVault": {
        "enabled": false,
        "vaultTransactionType": "Expere",
        "vaultName": "theLender"
    },
    "scheduled": false,
    "availableAt": "2024-12-09T14:11:42.481Z",
    "expiration": {
        "expirationType": "NONE"
    },
    "customFields": [
        {
            "id": "5IA2bRTO1EKxV1XbczmlI3",
            "friendlyId": "5IA2bRTO1EKxV1XbczmlI3",
            "customFieldId": "541hRQzKdVctlDV0K0ej4z",
            "friendlyCustomFieldId": "541hRQzKdVctlDV0K0ej4z",
            "name": "Address Line 1",
            "value": "123 Main St",
            "version": 0
        },
        {
            "id": "3Ri0j1S5G4hxDsXQyN2mCf",
            "friendlyId": "3Ri0j1S5G4hxDsXQyN2mCf",
            "customFieldId": "7D9wVxUA5PSGV4Z4XVZ0zs",
            "friendlyCustomFieldId": "7D9wVxUA5PSGV4Z4XVZ0zs",
            "name": "Agency Case ID",
            "value": "96321478",
            "version": 0
        },
        {
            "id": "7Ya3c95y625tyxG0Q94nua",
            "friendlyId": "7Ya3c95y625tyxG0Q94nua",
            "customFieldId": "4xHm4L5wNrjH259j9wQeai",
            "friendlyCustomFieldId": "4xHm4L5wNrjH259j9wQeai",
            "name": "City",
            "value": "Red Rock",
            "version": 0
        },
        {
            "id": "3GUBaZLsNURLT5ikbudnyA",
            "friendlyId": "3GUBaZLsNURLT5ikbudnyA",
            "customFieldId": "7ImRiLLrHcbciv5CZ2Ndk3",
            "friendlyCustomFieldId": "7ImRiLLrHcbciv5CZ2Ndk3",
            "name": "County",
            "value": "Mercer",
            "version": 0
        },
        {
            "id": "2ttb2ha0c3rh7qadb5bOuB",
            "friendlyId": "2ttb2ha0c3rh7qadb5bOuB",
            "customFieldId": "68jvriq8YZ0SFfRHiPXUac",
            "friendlyCustomFieldId": "68jvriq8YZ0SFfRHiPXUac",
            "name": "First Payment Due Date",
            "value": "2019-02-01",
            "version": 0
        },
        {
            "id": "3ESB9BbSFWw6Eb9s9AXhYG",
            "friendlyId": "3ESB9BbSFWw6Eb9s9AXhYG",
            "customFieldId": "6FOK0KJNC1rHs35RQeYbqb",
            "friendlyCustomFieldId": "6FOK0KJNC1rHs35RQeYbqb",
            "name": "Form Number Identifier (Note)",
            "value": "3200e",
            "version": 0
        },
        {
            "id": "c3HqBOozERSYLx65DBInq",
            "friendlyId": "c3HqBOozERSYLx65DBInq",
            "customFieldId": "3LID84KPR41unclSpmHu4D",
            "friendlyCustomFieldId": "3LID84KPR41unclSpmHu4D",
            "name": "Grace Period Days",
            "value": "15",
            "version": 0
        },
        {
            "id": "saMeCGSUWSE5aPp51qOh7",
            "friendlyId": "saMeCGSUWSE5aPp51qOh7",
            "customFieldId": "6GYsGdLH4Y9QCTI8URAkH8",
            "friendlyCustomFieldId": "6GYsGdLH4Y9QCTI8URAkH8",
            "name": "Late Charge Rate",
            "value": "5.0",
            "version": 0
        },
        {
            "id": "5bwFclsaIEtVXiLvIBmtkA",
            "friendlyId": "5bwFclsaIEtVXiLvIBmtkA",
            "customFieldId": "2KV8GV3W9bpAVMEY0eJ0Aw",
            "friendlyCustomFieldId": "2KV8GV3W9bpAVMEY0eJ0Aw",
            "name": "Lender Loan Number",
            "value": "Postman 1234",
            "version": 0
        },
        {
            "id": "74Y8doOrRr7iQrANDvdfTb",
            "friendlyId": "74Y8doOrRr7iQrANDvdfTb",
            "customFieldId": "1CztpcM8Me3vSKJp4Okgu3",
            "friendlyCustomFieldId": "1CztpcM8Me3vSKJp4Okgu3",
            "name": "Lender Name",
            "value": "ABC Mortgage",
            "version": 0
        },
        {
            "id": "6qnuFMg30LV9GJXIFJagDL",
            "friendlyId": "6qnuFMg30LV9GJXIFJagDL",
            "customFieldId": "4w36iURNCt0hF9RYt62Ov6",
            "friendlyCustomFieldId": "4w36iURNCt0hF9RYt62Ov6",
            "name": "Loan Maturity Date",
            "value": "2049-02-01",
            "version": 0
        },
        {
            "id": "EMumP8C89VOmoPLkEXiGY",
            "friendlyId": "EMumP8C89VOmoPLkEXiGY",
            "customFieldId": "6C8tz1d0ecdaPmp1A3ooA",
            "friendlyCustomFieldId": "6C8tz1d0ecdaPmp1A3ooA",
            "name": "MIN",
            "value": "999934400306958642",
            "version": 0
        },
        {
            "id": "1thlJlrmp5QMsECsa2rNTL",
            "friendlyId": "1thlJlrmp5QMsECsa2rNTL",
            "customFieldId": "4EfILHhqaSb28TPYe5qVQD",
            "friendlyCustomFieldId": "4EfILHhqaSb28TPYe5qVQD",
            "name": "Original Loan Amount",
            "value": "150000.0",
            "version": 0
        },
        {
            "id": "1EMhAcQVNhZN7pWeQyLbBg",
            "friendlyId": "1EMhAcQVNhZN7pWeQyLbBg",
            "customFieldId": "2mzhL6tIHnATw3GKBFXoQe",
            "friendlyCustomFieldId": "2mzhL6tIHnATw3GKBFXoQe",
            "name": "Original Note Rate",
            "value": "3.0",
            "version": 0
        },
        {
            "id": "3rRfds1u7YEcE0VNi7z7tU",
            "friendlyId": "3rRfds1u7YEcE0VNi7z7tU",
            "customFieldId": "6LHwSOb0187X5JvvDbOqaw",
            "friendlyCustomFieldId": "6LHwSOb0187X5JvvDbOqaw",
            "name": "P&I Amount",
            "value": "632.4",
            "version": 0
        },
        {
            "id": "R4UFSVT8gUFepJ9QHHhi6",
            "friendlyId": "R4UFSVT8gUFepJ9QHHhi6",
            "customFieldId": "2nXpCuVptTGF5d5GhYt7gP",
            "friendlyCustomFieldId": "2nXpCuVptTGF5d5GhYt7gP",
            "name": "Pay to Address",
            "value": "PO Box 1234",
            "version": 0
        },
        {
            "id": "7UicRFAzUBnhsTPR3nc1vO",
            "friendlyId": "7UicRFAzUBnhsTPR3nc1vO",
            "customFieldId": "1H2s3SvdrfbMfD2XzVHlfe",
            "friendlyCustomFieldId": "1H2s3SvdrfbMfD2XzVHlfe",
            "name": "Pay to City",
            "value": "New York",
            "version": 0
        },
        {
            "id": "2EC80k7TKoZMsHLdNHEZxA",
            "friendlyId": "2EC80k7TKoZMsHLdNHEZxA",
            "customFieldId": "51ZDwZp3XdPTcPlRexjpAS",
            "friendlyCustomFieldId": "51ZDwZp3XdPTcPlRexjpAS",
            "name": "Pay to State",
            "value": "NY",
            "version": 0
        },
        {
            "id": "3WhcnRwgqO4RG2u7H9CHY",
            "friendlyId": "3WhcnRwgqO4RG2u7H9CHY",
            "customFieldId": "3zS8SmBGCUl2GyiuGkopXG",
            "friendlyCustomFieldId": "3zS8SmBGCUl2GyiuGkopXG",
            "name": "Pay to Zip code",
            "value": "00123",
            "version": 0
        },
        {
            "id": "5CeYus6W1Ea4Yfqzet6lGR",
            "friendlyId": "5CeYus6W1Ea4Yfqzet6lGR",
            "customFieldId": "1cNdX5pddKN4sT6f7SlHVJ",
            "friendlyCustomFieldId": "1cNdX5pddKN4sT6f7SlHVJ",
            "name": "Payment Remittance Day",
            "value": "15",
            "version": 0
        },
        {
            "id": "6EMqez0zgH56zaC1WH6NU4",
            "friendlyId": "6EMqez0zgH56zaC1WH6NU4",
            "customFieldId": "5atDIXG2WumNuSeG2tgc2Q",
            "friendlyCustomFieldId": "5atDIXG2WumNuSeG2tgc2Q",
            "name": "Primary Borrower First Name",
            "value": "Jane",
            "version": 0
        },
        {
            "id": "3BVVN6y3WFmnZEwWKPPJJq",
            "friendlyId": "3BVVN6y3WFmnZEwWKPPJJq",
            "customFieldId": "6iD5ALXx4CRWtEPI80UqA7",
            "friendlyCustomFieldId": "6iD5ALXx4CRWtEPI80UqA7",
            "name": "Primary Borrower Last Name",
            "value": "SQA",
            "version": 0
        },
        {
            "id": "66spWvRNkvZHBtV7tkGzvr",
            "friendlyId": "66spWvRNkvZHBtV7tkGzvr",
            "customFieldId": "3IwjeiOV9wQpZ1qnGfC2Fl",
            "friendlyCustomFieldId": "3IwjeiOV9wQpZ1qnGfC2Fl",
            "name": "SMARTDoc Version",
            "value": "1.02",
            "version": 0
        },
        {
            "id": "74BMDqA51hCZaLcPLk7S4S",
            "friendlyId": "74BMDqA51hCZaLcPLk7S4S",
            "customFieldId": "5uvz8k7XOTGOPgm6uCsGaE",
            "friendlyCustomFieldId": "5uvz8k7XOTGOPgm6uCsGaE",
            "name": "State",
            "value": "MD",
            "version": 0
        },
        {
            "id": "6PYhH11om6hzcpqOPphcPf",
            "friendlyId": "6PYhH11om6hzcpqOPphcPf",
            "customFieldId": "36eAWJwAF3z3cYNAW26WVE",
            "friendlyCustomFieldId": "36eAWJwAF3z3cYNAW26WVE",
            "name": "Zip code",
            "value": "08601",
            "version": 0
        },
        {
            "id": "670nGrOg6x4YiuUPCEHzJH",
            "friendlyId": "670nGrOg6x4YiuUPCEHzJH",
            "customFieldId": "2P6w6sqG5VxcI7QefKPghk",
            "friendlyCustomFieldId": "2P6w6sqG5VxcI7QefKPghk",
            "name": "Expere EDS ID",
            "value": "989907",
            "version": 0
        },
        {
            "id": "7DBpsovETJ0AA92A7FVzA7",
            "friendlyId": "7DBpsovETJ0AA92A7FVzA7",
            "customFieldId": "10dzTVNudMDxG8AvAuXfXl",
            "friendlyCustomFieldId": "10dzTVNudMDxG8AvAuXfXl",
            "name": "Expere DGS ID",
            "value": "6fcc498c-788c-4107-a1e8-b17900c5719a",
            "version": 0
        }
    ],
    "paperOrder": "BEFORE_ESIGN",
    "stipsOrder": "BEFORE_ESIGN",
    "signingOrder": "ANY",
    "vaultTransactionType": "Expere",
    "avEsign": false,
    "packageCollaboration": false
}